Rollouts class
Class representing a Rollouts.
Constructors
| Rollouts(Azure |
Create a Rollouts. |
Methods
Constructor Details
Rollouts(AzureDeploymentManagerContext)
Create a Rollouts.
new Rollouts(client: AzureDeploymentManagerContext)Parameters
Reference to the service client.
Method Details
beginCreateOrUpdate(string, string, RolloutsBeginCreateOrUpdateOptionalParams)
This is an asynchronous operation and can be polled to completion using the location header returned by this operation.
function beginCreateOrUpdate(resourceGroupName: string, rolloutName: string, options?: RolloutsBeginCreateOrUpdateOptionalParams): Promise<LROPoller>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- rolloutName
-
string
The rollout name.
The optional parameters
Returns
Promise<@azure/ms-rest-azure-js.LROPoller>
Promise<msRestAzure.LROPoller>
cancel(string, string, RequestOptionsBase)
Only running rollouts can be canceled.
function cancel(resourceGroupName: string, rolloutName: string, options?: RequestOptionsBase): Promise<RolloutsCancelResponse>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- rolloutName
-
string
The rollout name.
- options
- RequestOptionsBase
The optional parameters
Returns
Promise<RolloutsCancelResponse>
Promise<Models.RolloutsCancelResponse>
cancel(string, string, RequestOptionsBase, ServiceCallback<Rollout>)
function cancel(resourceGroupName: string, rolloutName: string, options: RequestOptionsBase, callback: ServiceCallback<Rollout>)Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- rolloutName
-
string
The rollout name.
- options
- RequestOptionsBase
The optional parameters
- callback
The callback
cancel(string, string, ServiceCallback<Rollout>)
function cancel(resourceGroupName: string, rolloutName: string, callback: ServiceCallback<Rollout>)Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- rolloutName
-
string
The rollout name.
- callback
The callback
createOrUpdate(string, string, RolloutsCreateOrUpdateOptionalParams)
This is an asynchronous operation and can be polled to completion using the location header returned by this operation.
function createOrUpdate(resourceGroupName: string, rolloutName: string, options?: RolloutsCreateOrUpdateOptionalParams): Promise<RolloutsCreateOrUpdateResponse>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- rolloutName
-
string
The rollout name.
The optional parameters
Returns
Promise<RolloutsCreateOrUpdateResponse>
Promise<Models.RolloutsCreateOrUpdateResponse>
deleteMethod(string, string, RequestOptionsBase)
Only rollouts in terminal state can be deleted.
function deleteMethod(resourceGroupName: string, rolloutName: string, options?: RequestOptionsBase): Promise<RestResponse>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- rolloutName
-
string
The rollout name.
- options
- RequestOptionsBase
The optional parameters
Returns
Promise<RestResponse>
Promise<msRest.RestResponse>
deleteMethod(string, string, RequestOptionsBase, ServiceCallback<void>)
function deleteMethod(resourceGroupName: string, rolloutName: string, options: RequestOptionsBase, callback: ServiceCallback<void>)Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- rolloutName
-
string
The rollout name.
- options
- RequestOptionsBase
The optional parameters
- callback
-
ServiceCallback<void>
The callback
deleteMethod(string, string, ServiceCallback<void>)
function deleteMethod(resourceGroupName: string, rolloutName: string, callback: ServiceCallback<void>)Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- rolloutName
-
string
The rollout name.
- callback
-
ServiceCallback<void>
The callback
get(string, string, RolloutsGetOptionalParams)
function get(resourceGroupName: string, rolloutName: string, options?: RolloutsGetOptionalParams): Promise<RolloutsGetResponse>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- rolloutName
-
string
The rollout name.
- options
- RolloutsGetOptionalParams
The optional parameters
Returns
Promise<RolloutsGetResponse>
Promise<Models.RolloutsGetResponse>
get(string, string, RolloutsGetOptionalParams, ServiceCallback<Rollout>)
function get(resourceGroupName: string, rolloutName: string, options: RolloutsGetOptionalParams, callback: ServiceCallback<Rollout>)Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- rolloutName
-
string
The rollout name.
- options
- RolloutsGetOptionalParams
The optional parameters
- callback
The callback
get(string, string, ServiceCallback<Rollout>)
function get(resourceGroupName: string, rolloutName: string, callback: ServiceCallback<Rollout>)Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- rolloutName
-
string
The rollout name.
- callback
The callback
list(string, RequestOptionsBase)
function list(resourceGroupName: string, options?: RequestOptionsBase): Promise<RolloutsListResponse>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- options
- RequestOptionsBase
The optional parameters
Returns
Promise<RolloutsListResponse>
Promise<Models.RolloutsListResponse>
list(string, RequestOptionsBase, ServiceCallback<Rollout[]>)
function list(resourceGroupName: string, options: RequestOptionsBase, callback: ServiceCallback<Rollout[]>)Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- options
- RequestOptionsBase
The optional parameters
- callback
The callback
list(string, ServiceCallback<Rollout[]>)
function list(resourceGroupName: string, callback: ServiceCallback<Rollout[]>)Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- callback
The callback
restart(string, string, RolloutsRestartOptionalParams)
Only failed rollouts can be restarted.
function restart(resourceGroupName: string, rolloutName: string, options?: RolloutsRestartOptionalParams): Promise<RolloutsRestartResponse>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- rolloutName
-
string
The rollout name.
- options
- RolloutsRestartOptionalParams
The optional parameters
Returns
Promise<RolloutsRestartResponse>
Promise<Models.RolloutsRestartResponse>
restart(string, string, RolloutsRestartOptionalParams, ServiceCallback<Rollout>)
function restart(resourceGroupName: string, rolloutName: string, options: RolloutsRestartOptionalParams, callback: ServiceCallback<Rollout>)Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- rolloutName
-
string
The rollout name.
- options
- RolloutsRestartOptionalParams
The optional parameters
- callback
The callback
restart(string, string, ServiceCallback<Rollout>)
function restart(resourceGroupName: string, rolloutName: string, callback: ServiceCallback<Rollout>)Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- rolloutName
-
string
The rollout name.
- callback
The callback