Class OsManagementClient
Service client instance for OsManagement.
Implements
Inherited Members
Namespace: Oci.OsmanagementService
Assembly: OCI.DotNetSDK.Osmanagement.dll
Syntax
public class OsManagementClient : RegionalClientBase, IDisposable
Constructors
OsManagementClient(IBasicAuthenticationDetailsProvider, ClientConfiguration, string)
Creates a new service instance using the given authentication provider and/or client configuration and/or endpoint. A client configuration can also be provided optionally to adjust REST client behaviors.
Declaration
public OsManagementClient(IBasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration clientConfiguration = null, string endpoint = null)
Parameters
Type | Name | Description |
---|---|---|
IBasicAuthenticationDetailsProvider | authenticationDetailsProvider | The authentication details provider. Required. |
ClientConfiguration | clientConfiguration | The client configuration that contains settings to adjust REST client behaviors. Optional. |
string | endpoint | The endpoint of the service. If not provided and the client is a regional client, the endpoint will be constructed based on region information. Optional. |
Properties
Paginators
Declaration
public OsManagementPaginators Paginators { get; }
Property Value
Type | Description |
---|---|
OsManagementPaginators |
Waiters
Declaration
public OsManagementWaiters Waiters { get; }
Property Value
Type | Description |
---|---|
OsManagementWaiters |
Methods
AddPackagesToSoftwareSource(AddPackagesToSoftwareSourceRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Adds a given list of Software Packages to a specific Software Source.
Declaration
public Task<AddPackagesToSoftwareSourceResponse> AddPackagesToSoftwareSource(AddPackagesToSoftwareSourceRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
AddPackagesToSoftwareSourceRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<AddPackagesToSoftwareSourceResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use AddPackagesToSoftwareSource API.
AttachChildSoftwareSourceToManagedInstance(AttachChildSoftwareSourceToManagedInstanceRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Adds a child software source to a managed instance. After the software source has been added, then packages from that software source can be installed on the managed instance.
Declaration
public Task<AttachChildSoftwareSourceToManagedInstanceResponse> AttachChildSoftwareSourceToManagedInstance(AttachChildSoftwareSourceToManagedInstanceRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
AttachChildSoftwareSourceToManagedInstanceRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<AttachChildSoftwareSourceToManagedInstanceResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use AttachChildSoftwareSourceToManagedInstance API.
AttachManagedInstanceToManagedInstanceGroup(AttachManagedInstanceToManagedInstanceGroupRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Adds a Managed Instance to a Managed Instance Group. After the Managed Instance has been added, then operations can be performed on the Managed Instance Group which will then apply to all Managed Instances in the group.
Declaration
public Task<AttachManagedInstanceToManagedInstanceGroupResponse> AttachManagedInstanceToManagedInstanceGroup(AttachManagedInstanceToManagedInstanceGroupRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
AttachManagedInstanceToManagedInstanceGroupRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<AttachManagedInstanceToManagedInstanceGroupResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use AttachManagedInstanceToManagedInstanceGroup API.
AttachParentSoftwareSourceToManagedInstance(AttachParentSoftwareSourceToManagedInstanceRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Adds a parent software source to a managed instance. After the software source has been added, then packages from that software source can be installed on the managed instance. Software sources that have this software source as a parent will be able to be added to this managed instance.
Declaration
public Task<AttachParentSoftwareSourceToManagedInstanceResponse> AttachParentSoftwareSourceToManagedInstance(AttachParentSoftwareSourceToManagedInstanceRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
AttachParentSoftwareSourceToManagedInstanceRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<AttachParentSoftwareSourceToManagedInstanceResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use AttachParentSoftwareSourceToManagedInstance API.
ChangeManagedInstanceGroupCompartment(ChangeManagedInstanceGroupCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Moves a resource into a different compartment. When provided, If-Match is checked against ETag values of the resource.
Declaration
public Task<ChangeManagedInstanceGroupCompartmentResponse> ChangeManagedInstanceGroupCompartment(ChangeManagedInstanceGroupCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ChangeManagedInstanceGroupCompartmentRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ChangeManagedInstanceGroupCompartmentResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ChangeManagedInstanceGroupCompartment API.
ChangeScheduledJobCompartment(ChangeScheduledJobCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Moves a resource into a different compartment. When provided, If-Match is checked against ETag values of the resource.
Declaration
public Task<ChangeScheduledJobCompartmentResponse> ChangeScheduledJobCompartment(ChangeScheduledJobCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ChangeScheduledJobCompartmentRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ChangeScheduledJobCompartmentResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ChangeScheduledJobCompartment API.
ChangeSoftwareSourceCompartment(ChangeSoftwareSourceCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Moves a resource into a different compartment. When provided, If-Match is checked against ETag values of the resource.
Declaration
public Task<ChangeSoftwareSourceCompartmentResponse> ChangeSoftwareSourceCompartment(ChangeSoftwareSourceCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ChangeSoftwareSourceCompartmentRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ChangeSoftwareSourceCompartmentResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ChangeSoftwareSourceCompartment API.
CreateManagedInstanceGroup(CreateManagedInstanceGroupRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Creates a new Managed Instance Group on the management system. This will not contain any managed instances after it is first created, and they must be added later.
Declaration
public Task<CreateManagedInstanceGroupResponse> CreateManagedInstanceGroup(CreateManagedInstanceGroupRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
CreateManagedInstanceGroupRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<CreateManagedInstanceGroupResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use CreateManagedInstanceGroup API.
CreateScheduledJob(CreateScheduledJobRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Creates a new Scheduled Job to perform a specific package operation on a set of managed instances or managed instance groups. Can be created as a one-time execution in the future, or as a recurring execution that repeats on a defined interval.
Declaration
public Task<CreateScheduledJobResponse> CreateScheduledJob(CreateScheduledJobRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
CreateScheduledJobRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<CreateScheduledJobResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use CreateScheduledJob API.
CreateSoftwareSource(CreateSoftwareSourceRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Creates a new custom Software Source on the management system. This will not contain any packages after it is first created, and they must be added later.
Declaration
public Task<CreateSoftwareSourceResponse> CreateSoftwareSource(CreateSoftwareSourceRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
CreateSoftwareSourceRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<CreateSoftwareSourceResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use CreateSoftwareSource API.
DeleteManagedInstanceGroup(DeleteManagedInstanceGroupRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Deletes a Managed Instance Group from the management system
Declaration
public Task<DeleteManagedInstanceGroupResponse> DeleteManagedInstanceGroup(DeleteManagedInstanceGroupRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
DeleteManagedInstanceGroupRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<DeleteManagedInstanceGroupResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use DeleteManagedInstanceGroup API.
DeleteScheduledJob(DeleteScheduledJobRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Cancels an existing Scheduled Job on the management system
Declaration
public Task<DeleteScheduledJobResponse> DeleteScheduledJob(DeleteScheduledJobRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
DeleteScheduledJobRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<DeleteScheduledJobResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use DeleteScheduledJob API.
DeleteSoftwareSource(DeleteSoftwareSourceRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Deletes a custom Software Source on the management system
Declaration
public Task<DeleteSoftwareSourceResponse> DeleteSoftwareSource(DeleteSoftwareSourceRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
DeleteSoftwareSourceRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<DeleteSoftwareSourceResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use DeleteSoftwareSource API.
DetachChildSoftwareSourceFromManagedInstance(DetachChildSoftwareSourceFromManagedInstanceRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Removes a child software source from a managed instance. Packages will no longer be able to be installed from these software sources.
Declaration
public Task<DetachChildSoftwareSourceFromManagedInstanceResponse> DetachChildSoftwareSourceFromManagedInstance(DetachChildSoftwareSourceFromManagedInstanceRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
DetachChildSoftwareSourceFromManagedInstanceRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<DetachChildSoftwareSourceFromManagedInstanceResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use DetachChildSoftwareSourceFromManagedInstance API.
DetachManagedInstanceFromManagedInstanceGroup(DetachManagedInstanceFromManagedInstanceGroupRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Removes a Managed Instance from a Managed Instance Group.
Declaration
public Task<DetachManagedInstanceFromManagedInstanceGroupResponse> DetachManagedInstanceFromManagedInstanceGroup(DetachManagedInstanceFromManagedInstanceGroupRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
DetachManagedInstanceFromManagedInstanceGroupRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<DetachManagedInstanceFromManagedInstanceGroupResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use DetachManagedInstanceFromManagedInstanceGroup API.
DetachParentSoftwareSourceFromManagedInstance(DetachParentSoftwareSourceFromManagedInstanceRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Removes a software source from a managed instance. All child software sources will also be removed from the managed instance. Packages will no longer be able to be installed from these software sources.
Declaration
public Task<DetachParentSoftwareSourceFromManagedInstanceResponse> DetachParentSoftwareSourceFromManagedInstance(DetachParentSoftwareSourceFromManagedInstanceRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
DetachParentSoftwareSourceFromManagedInstanceRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<DetachParentSoftwareSourceFromManagedInstanceResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use DetachParentSoftwareSourceFromManagedInstance API.
DisableModuleStreamOnManagedInstance(DisableModuleStreamOnManagedInstanceRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Disables a module stream on a managed instance. After the stream is disabled, it is no longer possible to install the profiles that are contained by the stream. All installed profiles must be removed prior to disabling a module stream.
Declaration
public Task<DisableModuleStreamOnManagedInstanceResponse> DisableModuleStreamOnManagedInstance(DisableModuleStreamOnManagedInstanceRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
DisableModuleStreamOnManagedInstanceRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<DisableModuleStreamOnManagedInstanceResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use DisableModuleStreamOnManagedInstance API.
EnableModuleStreamOnManagedInstance(EnableModuleStreamOnManagedInstanceRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Enables a module stream on a managed instance. After the stream is enabled, it is possible to install the profiles that are contained by the stream. Enabling a stream that is already enabled will succeed. Attempting to enable a different stream for a module that already has a stream enabled results in an error.
Declaration
public Task<EnableModuleStreamOnManagedInstanceResponse> EnableModuleStreamOnManagedInstance(EnableModuleStreamOnManagedInstanceRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
EnableModuleStreamOnManagedInstanceRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<EnableModuleStreamOnManagedInstanceResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use EnableModuleStreamOnManagedInstance API.
GetErratum(GetErratumRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns a specific erratum.
Declaration
public Task<GetErratumResponse> GetErratum(GetErratumRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetErratumRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetErratumResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetErratum API.
GetManagedInstance(GetManagedInstanceRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns a specific Managed Instance.
Declaration
public Task<GetManagedInstanceResponse> GetManagedInstance(GetManagedInstanceRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetManagedInstanceRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetManagedInstanceResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetManagedInstance API.
GetManagedInstanceGroup(GetManagedInstanceGroupRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns a specific Managed Instance Group.
Declaration
public Task<GetManagedInstanceGroupResponse> GetManagedInstanceGroup(GetManagedInstanceGroupRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetManagedInstanceGroupRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetManagedInstanceGroupResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetManagedInstanceGroup API.
GetModuleStream(GetModuleStreamRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Retrieve a detailed description of a module stream from a software source.
Declaration
public Task<GetModuleStreamResponse> GetModuleStream(GetModuleStreamRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetModuleStreamRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetModuleStreamResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetModuleStream API.
GetModuleStreamProfile(GetModuleStreamProfileRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Retrieve a detailed description of a module stream profile from a software source.
Declaration
public Task<GetModuleStreamProfileResponse> GetModuleStreamProfile(GetModuleStreamProfileRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetModuleStreamProfileRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetModuleStreamProfileResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetModuleStreamProfile API.
GetScheduledJob(GetScheduledJobRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets the detailed information for the Scheduled Job with the given ID.
Declaration
public Task<GetScheduledJobResponse> GetScheduledJob(GetScheduledJobRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetScheduledJobRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetScheduledJobResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetScheduledJob API.
GetSoftwarePackage(GetSoftwarePackageRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns a specific Software Package.
Declaration
public Task<GetSoftwarePackageResponse> GetSoftwarePackage(GetSoftwarePackageRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetSoftwarePackageRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetSoftwarePackageResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetSoftwarePackage API.
GetSoftwareSource(GetSoftwareSourceRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns a specific Software Source.
Declaration
public Task<GetSoftwareSourceResponse> GetSoftwareSource(GetSoftwareSourceRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetSoftwareSourceRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetSoftwareSourceResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetSoftwareSource API.
GetWindowsUpdate(GetWindowsUpdateRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns a Windows Update object.
Declaration
public Task<GetWindowsUpdateResponse> GetWindowsUpdate(GetWindowsUpdateRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetWindowsUpdateRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetWindowsUpdateResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetWindowsUpdate API.
GetWorkRequest(GetWorkRequestRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets the detailed information for the work request with the given ID.
Declaration
public Task<GetWorkRequestResponse> GetWorkRequest(GetWorkRequestRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetWorkRequestRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetWorkRequestResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetWorkRequest API.
InstallAllPackageUpdatesOnManagedInstance(InstallAllPackageUpdatesOnManagedInstanceRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Install all of the available package updates for the managed instance.
Declaration
public Task<InstallAllPackageUpdatesOnManagedInstanceResponse> InstallAllPackageUpdatesOnManagedInstance(InstallAllPackageUpdatesOnManagedInstanceRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
InstallAllPackageUpdatesOnManagedInstanceRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<InstallAllPackageUpdatesOnManagedInstanceResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use InstallAllPackageUpdatesOnManagedInstance API.
InstallAllUpdatesOnManagedInstanceGroup(InstallAllUpdatesOnManagedInstanceGroupRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Install all of the available updates for the Managed Instance Group.
Declaration
public Task<InstallAllUpdatesOnManagedInstanceGroupResponse> InstallAllUpdatesOnManagedInstanceGroup(InstallAllUpdatesOnManagedInstanceGroupRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
InstallAllUpdatesOnManagedInstanceGroupRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<InstallAllUpdatesOnManagedInstanceGroupResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use InstallAllUpdatesOnManagedInstanceGroup API.
InstallAllWindowsUpdatesOnManagedInstance(InstallAllWindowsUpdatesOnManagedInstanceRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Install all of the available Windows updates for the managed instance.
Declaration
public Task<InstallAllWindowsUpdatesOnManagedInstanceResponse> InstallAllWindowsUpdatesOnManagedInstance(InstallAllWindowsUpdatesOnManagedInstanceRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
InstallAllWindowsUpdatesOnManagedInstanceRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<InstallAllWindowsUpdatesOnManagedInstanceResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use InstallAllWindowsUpdatesOnManagedInstance API.
InstallModuleStreamProfileOnManagedInstance(InstallModuleStreamProfileOnManagedInstanceRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Installs a profile for an module stream. The stream must be enabled before a profile can be installed. If a module stream defines multiple profiles, each one can be installed independently.
Declaration
public Task<InstallModuleStreamProfileOnManagedInstanceResponse> InstallModuleStreamProfileOnManagedInstance(InstallModuleStreamProfileOnManagedInstanceRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
InstallModuleStreamProfileOnManagedInstanceRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<InstallModuleStreamProfileOnManagedInstanceResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use InstallModuleStreamProfileOnManagedInstance API.
InstallPackageOnManagedInstance(InstallPackageOnManagedInstanceRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Installs a package on a managed instance.
Declaration
public Task<InstallPackageOnManagedInstanceResponse> InstallPackageOnManagedInstance(InstallPackageOnManagedInstanceRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
InstallPackageOnManagedInstanceRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<InstallPackageOnManagedInstanceResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use InstallPackageOnManagedInstance API.
InstallPackageUpdateOnManagedInstance(InstallPackageUpdateOnManagedInstanceRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Updates a package on a managed instance.
Declaration
public Task<InstallPackageUpdateOnManagedInstanceResponse> InstallPackageUpdateOnManagedInstance(InstallPackageUpdateOnManagedInstanceRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
InstallPackageUpdateOnManagedInstanceRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<InstallPackageUpdateOnManagedInstanceResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use InstallPackageUpdateOnManagedInstance API.
InstallWindowsUpdateOnManagedInstance(InstallWindowsUpdateOnManagedInstanceRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Installs a Windows update on a managed instance.
Declaration
public Task<InstallWindowsUpdateOnManagedInstanceResponse> InstallWindowsUpdateOnManagedInstance(InstallWindowsUpdateOnManagedInstanceRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
InstallWindowsUpdateOnManagedInstanceRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<InstallWindowsUpdateOnManagedInstanceResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use InstallWindowsUpdateOnManagedInstance API.
ListAvailablePackagesForManagedInstance(ListAvailablePackagesForManagedInstanceRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns a list of packages available for install on the Managed Instance.
Declaration
public Task<ListAvailablePackagesForManagedInstanceResponse> ListAvailablePackagesForManagedInstance(ListAvailablePackagesForManagedInstanceRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListAvailablePackagesForManagedInstanceRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListAvailablePackagesForManagedInstanceResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListAvailablePackagesForManagedInstance API.
ListAvailableSoftwareSourcesForManagedInstance(ListAvailableSoftwareSourcesForManagedInstanceRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns a list of available software sources for a Managed Instance.
Declaration
public Task<ListAvailableSoftwareSourcesForManagedInstanceResponse> ListAvailableSoftwareSourcesForManagedInstance(ListAvailableSoftwareSourcesForManagedInstanceRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListAvailableSoftwareSourcesForManagedInstanceRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListAvailableSoftwareSourcesForManagedInstanceResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListAvailableSoftwareSourcesForManagedInstance API.
ListAvailableUpdatesForManagedInstance(ListAvailableUpdatesForManagedInstanceRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns a list of available updates for a Managed Instance.
Declaration
public Task<ListAvailableUpdatesForManagedInstanceResponse> ListAvailableUpdatesForManagedInstance(ListAvailableUpdatesForManagedInstanceRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListAvailableUpdatesForManagedInstanceRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListAvailableUpdatesForManagedInstanceResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListAvailableUpdatesForManagedInstance API.
ListAvailableWindowsUpdatesForManagedInstance(ListAvailableWindowsUpdatesForManagedInstanceRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns a list of available Windows updates for a Managed Instance. This is only applicable to Windows instances.
Declaration
public Task<ListAvailableWindowsUpdatesForManagedInstanceResponse> ListAvailableWindowsUpdatesForManagedInstance(ListAvailableWindowsUpdatesForManagedInstanceRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListAvailableWindowsUpdatesForManagedInstanceRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListAvailableWindowsUpdatesForManagedInstanceResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListAvailableWindowsUpdatesForManagedInstance API.
ListErrata(ListErrataRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns a list of all of the currently available Errata in the system
Declaration
public Task<ListErrataResponse> ListErrata(ListErrataRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListErrataRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListErrataResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListErrata API.
ListManagedInstanceErrata(ListManagedInstanceErrataRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns a list of errata relevant to the Managed Instance.
Declaration
public Task<ListManagedInstanceErrataResponse> ListManagedInstanceErrata(ListManagedInstanceErrataRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListManagedInstanceErrataRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListManagedInstanceErrataResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListManagedInstanceErrata API.
ListManagedInstanceGroups(ListManagedInstanceGroupsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns a list of all Managed Instance Groups.
Declaration
public Task<ListManagedInstanceGroupsResponse> ListManagedInstanceGroups(ListManagedInstanceGroupsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListManagedInstanceGroupsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListManagedInstanceGroupsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListManagedInstanceGroups API.
ListManagedInstances(ListManagedInstancesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns a list of all Managed Instances.
Declaration
public Task<ListManagedInstancesResponse> ListManagedInstances(ListManagedInstancesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListManagedInstancesRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListManagedInstancesResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListManagedInstances API.
ListModuleStreamProfiles(ListModuleStreamProfilesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Retrieve a list of module stream profiles from a software source. Filters may be applied to select a subset of module stream profiles based on the filter criteria. <br/> The "moduleName", "streamName", and "profileName" attributes combine to form a set of filters on the list of module stream profiles. If a "moduleName" is provided, only profiles that belong to that module are returned. If both a "moduleName" and "streamName" are given, only profiles belonging to that module stream are returned. Finally, if all three are given then only the particular profile indicated by the triple is returned. It is not valid to supply a "streamName" without a "moduleName". It is also not valid to supply a "profileName" without a "streamName".
Declaration
public Task<ListModuleStreamProfilesResponse> ListModuleStreamProfiles(ListModuleStreamProfilesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListModuleStreamProfilesRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListModuleStreamProfilesResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListModuleStreamProfiles API.
ListModuleStreamProfilesOnManagedInstance(ListModuleStreamProfilesOnManagedInstanceRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Retrieve a list of module stream profiles, along with a summary of their of their status, from a managed instance. Filters may be applied to select a subset of profiles based on the filter criteria. <br/> The "moduleName", "streamName", and "profileName" attributes combine to form a set of filters on the list of module stream profiles. If a "modulName" is provided, only profiles that belong to that module are returned. If both a "moduleName" and "streamName" are given, only profiles belonging to that module stream are returned. Finally, if all three are given then only the particular profile indicated by the triple is returned. It is not valid to supply a "streamName" without a "moduleName". It is also not valid to supply a "profileName" without a "streamName". <br/> The "status" attribute filters against the state of a module stream profile. Valid values are "INSTALLED" and "AVAILABLE". If the attribute is set to "INSTALLED", only module stream profiles that are installed are included in the result set. If the attribute is set to "AVAILABLE", only module stream profiles that are not installed are included in the result set. If the attribute is not defined, the request is not subject to this filter. <br/> When sorting by display name, the result set is sorted first by module name, then by stream name, and finally by profile name.
Declaration
public Task<ListModuleStreamProfilesOnManagedInstanceResponse> ListModuleStreamProfilesOnManagedInstance(ListModuleStreamProfilesOnManagedInstanceRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListModuleStreamProfilesOnManagedInstanceRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListModuleStreamProfilesOnManagedInstanceResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListModuleStreamProfilesOnManagedInstance API.
ListModuleStreams(ListModuleStreamsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Retrieve a list of module streams from a software source. Filters may be applied to select a subset of module streams based on the filter criteria. <br/> The 'moduleName' attribute filters against the name of a module. It accepts strings of the format "<module>". If this attribute is defined, only streams that belong to the specified module are included in the result set. If it is not defined, the request is not subject to this filter. The 'streamName' attribute filters against the name of a stream of a module. If this attribute is defined, only the particular module stream that matches both the module and stream names is included in the result set. It is not valid to supply 'streamName' without also supplying a 'moduleName'. <br/> When sorting by display name, the result set is sorted first by module name, then by stream name.
Declaration
public Task<ListModuleStreamsResponse> ListModuleStreams(ListModuleStreamsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListModuleStreamsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListModuleStreamsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListModuleStreams API.
ListModuleStreamsOnManagedInstance(ListModuleStreamsOnManagedInstanceRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Retrieve a list of module streams, along with a summary of their status, from a managed instance. Filters may be applied to select a subset of module streams based on the filter criteria. <br/> The 'moduleName' attribute filters against the name of a module. It accepts strings of the format "<module>". If this attribute is defined, only streams that belong to the specified module are included in the result set. If it is not defined, the request is not subject to this filter. <br/> The "status" attribute filters against the state of a module stream. Valid values are "ENABLED", "DISABLED", and "ACTIVE". If the attribute is set to "ENABLED", only module streams that are enabled are included in the result set. If the attribute is set to "DISABLED", only module streams that are not enabled are included in the result set. If the attribute is set to "ACTIVE", only module streams that are active are included in the result set. If the attribute is not defined, the request is not subject to this filter. <br/> When sorting by the display name, the result set is sorted first by the module name and then by the stream name.
Declaration
public Task<ListModuleStreamsOnManagedInstanceResponse> ListModuleStreamsOnManagedInstance(ListModuleStreamsOnManagedInstanceRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListModuleStreamsOnManagedInstanceRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListModuleStreamsOnManagedInstanceResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListModuleStreamsOnManagedInstance API.
ListPackagesInstalledOnManagedInstance(ListPackagesInstalledOnManagedInstanceRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns a list of installed packages on the Managed Instance.
Declaration
public Task<ListPackagesInstalledOnManagedInstanceResponse> ListPackagesInstalledOnManagedInstance(ListPackagesInstalledOnManagedInstanceRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListPackagesInstalledOnManagedInstanceRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListPackagesInstalledOnManagedInstanceResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListPackagesInstalledOnManagedInstance API.
ListScheduledJobs(ListScheduledJobsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns a list of all of the currently active Scheduled Jobs in the system
Declaration
public Task<ListScheduledJobsResponse> ListScheduledJobs(ListScheduledJobsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListScheduledJobsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListScheduledJobsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListScheduledJobs API.
ListSoftwareSourcePackages(ListSoftwareSourcePackagesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Lists Software Packages in a Software Source
Declaration
public Task<ListSoftwareSourcePackagesResponse> ListSoftwareSourcePackages(ListSoftwareSourcePackagesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListSoftwareSourcePackagesRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListSoftwareSourcePackagesResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListSoftwareSourcePackages API.
ListSoftwareSources(ListSoftwareSourcesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns a list of all Software Sources.
Declaration
public Task<ListSoftwareSourcesResponse> ListSoftwareSources(ListSoftwareSourcesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListSoftwareSourcesRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListSoftwareSourcesResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListSoftwareSources API.
ListUpcomingScheduledJobs(ListUpcomingScheduledJobsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns a list of all of the Scheduled Jobs whose next execution time is at or before the specified time.
Declaration
public Task<ListUpcomingScheduledJobsResponse> ListUpcomingScheduledJobs(ListUpcomingScheduledJobsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListUpcomingScheduledJobsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListUpcomingScheduledJobsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListUpcomingScheduledJobs API.
ListWindowsUpdates(ListWindowsUpdatesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns a list of Windows Updates.
Declaration
public Task<ListWindowsUpdatesResponse> ListWindowsUpdates(ListWindowsUpdatesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListWindowsUpdatesRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListWindowsUpdatesResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListWindowsUpdates API.
ListWindowsUpdatesInstalledOnManagedInstance(ListWindowsUpdatesInstalledOnManagedInstanceRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns a list of installed Windows updates for a Managed Instance. This is only applicable to Windows instances.
Declaration
public Task<ListWindowsUpdatesInstalledOnManagedInstanceResponse> ListWindowsUpdatesInstalledOnManagedInstance(ListWindowsUpdatesInstalledOnManagedInstanceRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListWindowsUpdatesInstalledOnManagedInstanceRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListWindowsUpdatesInstalledOnManagedInstanceResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListWindowsUpdatesInstalledOnManagedInstance API.
ListWorkRequestErrors(ListWorkRequestErrorsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets the errors for the work request with the given ID.
Declaration
public Task<ListWorkRequestErrorsResponse> ListWorkRequestErrors(ListWorkRequestErrorsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListWorkRequestErrorsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListWorkRequestErrorsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListWorkRequestErrors API.
ListWorkRequestLogs(ListWorkRequestLogsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Lists the log entries for the work request with the given ID.
Declaration
public Task<ListWorkRequestLogsResponse> ListWorkRequestLogs(ListWorkRequestLogsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListWorkRequestLogsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListWorkRequestLogsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListWorkRequestLogs API.
ListWorkRequests(ListWorkRequestsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Lists the work requests in a compartment.
Declaration
public Task<ListWorkRequestsResponse> ListWorkRequests(ListWorkRequestsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListWorkRequestsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListWorkRequestsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListWorkRequests API.
ManageModuleStreamsOnManagedInstance(ManageModuleStreamsOnManagedInstanceRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Perform an operation involving modules, streams, and profiles on a managed instance. Each operation may enable or disable an arbitrary amount of module streams, and install or remove an arbitrary number of module stream profiles. When the operation is complete, the state of the modules, streams, and profiles on the managed instance will match the state indicated in the operation. <br/> Each module stream specified in the list of module streams to enable will be in the "ENABLED" state upon completion of the operation. If there was already a stream of that module enabled, any work required to switch from the current stream to the new stream is performed implicitly. <br/> Each module stream specified in the list of module streams to disable will be in the "DISABLED" state upon completion of the operation. Any profiles that are installed for the module stream will be removed as part of the operation. <br/> Each module stream profile specified in the list of profiles to install will be in the "INSTALLED" state upon completion of the operation, indicating that any packages that are part of the profile are installed on the managed instance. If the module stream containing the profile is not enabled, it will be enabled as part of the operation. There is an exception when attempting to install a stream of a profile when another stream of the same module is enabled. It is an error to attempt to install a profile of another module stream, unless enabling the new module stream is explicitly included in this operation. <br/> Each module stream profile specified in the list of profiles to remove will be in the "AVAILABLE" state upon completion of the operation. The status of packages within the profile after the operation is complete is defined by the package manager on the managed instance. <br/> Operations that contain one or more elements that are not allowed are rejected. <br/> The result of this request is a WorkRequest object. The returned WorkRequest is the parent of a structure of other WorkRequests. Taken as a whole, this structure indicates the entire set of work to be performed to complete the operation. <br/> This interface can also be used to perform a dry run of the operation rather than committing it to a managed instance. If a dry run is requested, the OS Management Service will evaluate the operation against the current module, stream, and profile state on the managed instance. It will calculate the impact of the operation on all modules, streams, and profiles on the managed instance, including those that are implicitly impacted by the operation. <br/> The WorkRequest resulting from a dry run behaves differently than a WorkRequest resulting from a committable operation. Dry run WorkRequests are always singletons and never have children. The impact of the operation is returned using the log and error facilities of WorkRequests. The impact of operations that are allowed by the OS Management Service are communicated as one or more work request log entries. Operations that are not allowed by the OS Management Service are communicated as one or more work requst error entries. Each entry, for either logs or errors, contains a structured message containing the results of one or more operations.
Declaration
public Task<ManageModuleStreamsOnManagedInstanceResponse> ManageModuleStreamsOnManagedInstance(ManageModuleStreamsOnManagedInstanceRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ManageModuleStreamsOnManagedInstanceRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ManageModuleStreamsOnManagedInstanceResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ManageModuleStreamsOnManagedInstance API.
RemoveModuleStreamProfileFromManagedInstance(RemoveModuleStreamProfileFromManagedInstanceRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Removes a profile for a module stream that is installed on a managed instance. If a module stream is provided, rather than a fully qualified profile, all profiles that have been installed for the module stream will be removed.
Declaration
public Task<RemoveModuleStreamProfileFromManagedInstanceResponse> RemoveModuleStreamProfileFromManagedInstance(RemoveModuleStreamProfileFromManagedInstanceRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
RemoveModuleStreamProfileFromManagedInstanceRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<RemoveModuleStreamProfileFromManagedInstanceResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use RemoveModuleStreamProfileFromManagedInstance API.
RemovePackageFromManagedInstance(RemovePackageFromManagedInstanceRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Removes an installed package from a managed instance.
Declaration
public Task<RemovePackageFromManagedInstanceResponse> RemovePackageFromManagedInstance(RemovePackageFromManagedInstanceRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
RemovePackageFromManagedInstanceRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<RemovePackageFromManagedInstanceResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use RemovePackageFromManagedInstance API.
RemovePackagesFromSoftwareSource(RemovePackagesFromSoftwareSourceRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Removes a given list of Software Packages from a specific Software Source.
Declaration
public Task<RemovePackagesFromSoftwareSourceResponse> RemovePackagesFromSoftwareSource(RemovePackagesFromSoftwareSourceRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
RemovePackagesFromSoftwareSourceRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<RemovePackagesFromSoftwareSourceResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use RemovePackagesFromSoftwareSource API.
RunScheduledJobNow(RunScheduledJobNowRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
This will trigger an already created Scheduled Job to being executing immediately instead of waiting for its next regularly scheduled time.
Declaration
public Task<RunScheduledJobNowResponse> RunScheduledJobNow(RunScheduledJobNowRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
RunScheduledJobNowRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<RunScheduledJobNowResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use RunScheduledJobNow API.
SearchSoftwarePackages(SearchSoftwarePackagesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Searches all of the available Software Sources and returns any/all Software Packages matching the search criteria.
Declaration
public Task<SearchSoftwarePackagesResponse> SearchSoftwarePackages(SearchSoftwarePackagesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
SearchSoftwarePackagesRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<SearchSoftwarePackagesResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use SearchSoftwarePackages API.
SkipNextScheduledJobExecution(SkipNextScheduledJobExecutionRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
This will force an already created Scheduled Job to skip its next regularly scheduled execution
Declaration
public Task<SkipNextScheduledJobExecutionResponse> SkipNextScheduledJobExecution(SkipNextScheduledJobExecutionRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
SkipNextScheduledJobExecutionRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<SkipNextScheduledJobExecutionResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use SkipNextScheduledJobExecution API.
SwitchModuleStreamOnManagedInstance(SwitchModuleStreamOnManagedInstanceRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Enables a new stream for a module that already has a stream enabled. If any profiles or packages from the original module are installed, switching to a new stream will remove the existing packages and install their counterparts in the new stream.
Declaration
public Task<SwitchModuleStreamOnManagedInstanceResponse> SwitchModuleStreamOnManagedInstance(SwitchModuleStreamOnManagedInstanceRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
SwitchModuleStreamOnManagedInstanceRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<SwitchModuleStreamOnManagedInstanceResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use SwitchModuleStreamOnManagedInstance API.
UpdateManagedInstance(UpdateManagedInstanceRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Updates a specific Managed Instance.
Declaration
public Task<UpdateManagedInstanceResponse> UpdateManagedInstance(UpdateManagedInstanceRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
UpdateManagedInstanceRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<UpdateManagedInstanceResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use UpdateManagedInstance API.
UpdateManagedInstanceGroup(UpdateManagedInstanceGroupRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Updates a specific Managed Instance Group.
Declaration
public Task<UpdateManagedInstanceGroupResponse> UpdateManagedInstanceGroup(UpdateManagedInstanceGroupRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
UpdateManagedInstanceGroupRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<UpdateManagedInstanceGroupResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use UpdateManagedInstanceGroup API.
UpdateScheduledJob(UpdateScheduledJobRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Updates an existing Scheduled Job on the management system.
Declaration
public Task<UpdateScheduledJobResponse> UpdateScheduledJob(UpdateScheduledJobRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
UpdateScheduledJobRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<UpdateScheduledJobResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use UpdateScheduledJob API.
UpdateSoftwareSource(UpdateSoftwareSourceRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Updates an existing custom Software Source on the management system.
Declaration
public Task<UpdateSoftwareSourceResponse> UpdateSoftwareSource(UpdateSoftwareSourceRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
UpdateSoftwareSourceRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<UpdateSoftwareSourceResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use UpdateSoftwareSource API.