Class SiteDeploymentCollection
A class representing a collection of SiteDeploymentResource and their operations. Each SiteDeploymentResource in the collection will belong to the same instance of WebSiteResource. To get a SiteDeploymentCollection instance call the GetSiteDeployments method from an instance of WebSiteResource.
Inheritance
Namespace: System.Dynamic.ExpandoObject
Assembly: Azure.ResourceManager.AppService.dll
Syntax
public class SiteDeploymentCollection : Azure.ResourceManager.ArmCollection, System.Collections.Generic.IAsyncEnumerable<Azure.ResourceManager.AppService.SiteDeploymentResource>, System.Collections.Generic.IEnumerable<Azure.ResourceManager.AppService.SiteDeploymentResource>
Constructors
SiteDeploymentCollection()
Initializes a new instance of the SiteDeploymentCollection class for mocking.
Declaration
protected SiteDeploymentCollection ();
Methods
CreateOrUpdate(WaitUntil, String, DeploymentData, CancellationToken)
Description for Create a deployment for an app, or a deployment slot. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/deployments/{id} Operation Id: WebApps_CreateDeployment
Declaration
public virtual Azure.ResourceManager.ArmOperation<Azure.ResourceManager.AppService.SiteDeploymentResource> CreateOrUpdate (Azure.WaitUntil waitUntil, string id, Azure.ResourceManager.AppService.DeploymentData data, System.Threading.CancellationToken cancellationToken = null);
Parameters
Azure.WaitUntil
waitUntil
Azure.WaitUntil.Completed if the method should wait to return until the long-running operation has completed on the service; Azure.WaitUntil.Started if it should return after starting the operation. For more information on long-running operations, please see Azure.Core Long-Running Operation samples. |
System.String
id
ID of an existing deployment. |
DeploymentData
data
Deployment details. |
System.Threading.CancellationToken
cancellationToken
The cancellation token to use. |
Returns
Azure.ResourceManager.ArmOperation<SiteDeploymentResource>
|
Exceptions
System.ArgumentException
|
System.ArgumentNullException
|
CreateOrUpdateAsync(WaitUntil, String, DeploymentData, CancellationToken)
Description for Create a deployment for an app, or a deployment slot. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/deployments/{id} Operation Id: WebApps_CreateDeployment
Declaration
[System.Diagnostics.DebuggerStepThrough]
public virtual System.Threading.Tasks.Task<Azure.ResourceManager.ArmOperation<Azure.ResourceManager.AppService.SiteDeploymentResource>> CreateOrUpdateAsync (Azure.WaitUntil waitUntil, string id, Azure.ResourceManager.AppService.DeploymentData data, System.Threading.CancellationToken cancellationToken = null);
Parameters
Azure.WaitUntil
waitUntil
Azure.WaitUntil.Completed if the method should wait to return until the long-running operation has completed on the service; Azure.WaitUntil.Started if it should return after starting the operation. For more information on long-running operations, please see Azure.Core Long-Running Operation samples. |
System.String
id
ID of an existing deployment. |
DeploymentData
data
Deployment details. |
System.Threading.CancellationToken
cancellationToken
The cancellation token to use. |
Returns
System.Threading.Tasks.Task<Azure.ResourceManager.ArmOperation<SiteDeploymentResource>>
|
Exceptions
System.ArgumentException
|
System.ArgumentNullException
|
Exists(String, CancellationToken)
Checks to see if the resource exists in azure. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/deployments/{id} Operation Id: WebApps_GetDeployment
Declaration
public virtual Azure.Response<bool> Exists (string id, System.Threading.CancellationToken cancellationToken = null);
Parameters
System.String
id
Deployment ID. |
System.Threading.CancellationToken
cancellationToken
The cancellation token to use. |
Returns
Azure.Response<System.Boolean>
|
Exceptions
System.ArgumentException
|
System.ArgumentNullException
|
ExistsAsync(String, CancellationToken)
Checks to see if the resource exists in azure. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/deployments/{id} Operation Id: WebApps_GetDeployment
Declaration
[System.Diagnostics.DebuggerStepThrough]
public virtual System.Threading.Tasks.Task<Azure.Response<bool>> ExistsAsync (string id, System.Threading.CancellationToken cancellationToken = null);
Parameters
System.String
id
Deployment ID. |
System.Threading.CancellationToken
cancellationToken
The cancellation token to use. |
Returns
System.Threading.Tasks.Task<Azure.Response<System.Boolean>>
|
Exceptions
System.ArgumentException
|
System.ArgumentNullException
|
Get(String, CancellationToken)
Description for Get a deployment by its ID for an app, or a deployment slot. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/deployments/{id} Operation Id: WebApps_GetDeployment
Declaration
public virtual Azure.Response<Azure.ResourceManager.AppService.SiteDeploymentResource> Get (string id, System.Threading.CancellationToken cancellationToken = null);
Parameters
System.String
id
Deployment ID. |
System.Threading.CancellationToken
cancellationToken
The cancellation token to use. |
Returns
Azure.Response<SiteDeploymentResource>
|
Exceptions
System.ArgumentException
|
System.ArgumentNullException
|
GetAll(CancellationToken)
Description for List deployments for an app, or a deployment slot. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/deployments Operation Id: WebApps_ListDeployments
Declaration
public virtual Azure.Pageable<Azure.ResourceManager.AppService.SiteDeploymentResource> GetAll (System.Threading.CancellationToken cancellationToken = null);
Parameters
System.Threading.CancellationToken
cancellationToken
The cancellation token to use. |
Returns
Azure.Pageable<SiteDeploymentResource>
A collection of SiteDeploymentResource that may take multiple service requests to iterate over. |
GetAllAsync(CancellationToken)
Description for List deployments for an app, or a deployment slot. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/deployments Operation Id: WebApps_ListDeployments
Declaration
public virtual Azure.AsyncPageable<Azure.ResourceManager.AppService.SiteDeploymentResource> GetAllAsync (System.Threading.CancellationToken cancellationToken = null);
Parameters
System.Threading.CancellationToken
cancellationToken
The cancellation token to use. |
Returns
Azure.AsyncPageable<SiteDeploymentResource>
An async collection of SiteDeploymentResource that may take multiple service requests to iterate over. |
GetAsync(String, CancellationToken)
Description for Get a deployment by its ID for an app, or a deployment slot. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/deployments/{id} Operation Id: WebApps_GetDeployment
Declaration
[System.Diagnostics.DebuggerStepThrough]
public virtual System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.AppService.SiteDeploymentResource>> GetAsync (string id, System.Threading.CancellationToken cancellationToken = null);
Parameters
System.String
id
Deployment ID. |
System.Threading.CancellationToken
cancellationToken
The cancellation token to use. |
Returns
System.Threading.Tasks.Task<Azure.Response<SiteDeploymentResource>>
|
Exceptions
System.ArgumentException
|
System.ArgumentNullException
|
Explicit Interface Implementations
IAsyncEnumerable<SiteDeploymentResource>.GetAsyncEnumerator(CancellationToken)
Returns an enumerator that iterates asynchronously through the collection.
Declaration
System.Collections.Generic.IAsyncEnumerator<Azure.ResourceManager.AppService.SiteDeploymentResource> IAsyncEnumerable<SiteDeploymentResource>.GetAsyncEnumerator (System.Threading.CancellationToken cancellationToken);
Parameters
System.Threading.CancellationToken
cancellationToken
A System.Threading.CancellationToken that may be used to cancel the asynchronous iteration. |
Returns
System.Collections.Generic.IAsyncEnumerator<SiteDeploymentResource>
An enumerator that can be used to iterate asynchronously through the collection. |
IEnumerable<SiteDeploymentResource>.GetEnumerator()
Returns an enumerator that iterates through the collection.
Declaration
System.Collections.Generic.IEnumerator<Azure.ResourceManager.AppService.SiteDeploymentResource> IEnumerable<SiteDeploymentResource>.GetEnumerator ();
Returns
System.Collections.Generic.IEnumerator<SiteDeploymentResource>
An enumerator that can be used to iterate through the collection. |
IEnumerable.GetEnumerator()
Returns an enumerator that iterates through a collection.
Declaration
System.Collections.IEnumerator IEnumerable.GetEnumerator ();
Returns
System.Collections.IEnumerator
An System.Collections.IEnumerator object that can be used to iterate through the collection. |