Class SiteSlotCollection
A class representing a collection of SiteSlotResource and their operations. Each SiteSlotResource in the collection will belong to the same instance of WebSiteResource. To get a SiteSlotCollection instance call the GetSiteSlots method from an instance of WebSiteResource.
Inheritance
Namespace: System.Dynamic.ExpandoObject
Assembly: Azure.ResourceManager.AppService.dll
Syntax
public class SiteSlotCollection : Azure.ResourceManager.ArmCollection, System.Collections.Generic.IAsyncEnumerable<Azure.ResourceManager.AppService.SiteSlotResource>, System.Collections.Generic.IEnumerable<Azure.ResourceManager.AppService.SiteSlotResource>
Constructors
SiteSlotCollection()
Initializes a new instance of the SiteSlotCollection class for mocking.
Declaration
protected SiteSlotCollection ();
Methods
CreateOrUpdate(WaitUntil, String, WebSiteData, CancellationToken)
Description for Creates a new web, mobile, or API app in an existing resource group, or updates an existing app. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot} Operation Id: WebApps_CreateOrUpdateSlot
Declaration
public virtual Azure.ResourceManager.ArmOperation<Azure.ResourceManager.AppService.SiteSlotResource> CreateOrUpdate (Azure.WaitUntil waitUntil, string slot, Azure.ResourceManager.AppService.WebSiteData 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
slot
Name of the deployment slot to create or update. By default, this API attempts to create or modify the production slot. |
WebSiteData
data
A JSON representation of the app properties. See example. |
System.Threading.CancellationToken
cancellationToken
The cancellation token to use. |
Returns
Azure.ResourceManager.ArmOperation<SiteSlotResource>
|
Exceptions
System.ArgumentException
|
System.ArgumentNullException
|
CreateOrUpdateAsync(WaitUntil, String, WebSiteData, CancellationToken)
Description for Creates a new web, mobile, or API app in an existing resource group, or updates an existing app. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot} Operation Id: WebApps_CreateOrUpdateSlot
Declaration
[System.Diagnostics.DebuggerStepThrough]
public virtual System.Threading.Tasks.Task<Azure.ResourceManager.ArmOperation<Azure.ResourceManager.AppService.SiteSlotResource>> CreateOrUpdateAsync (Azure.WaitUntil waitUntil, string slot, Azure.ResourceManager.AppService.WebSiteData 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
slot
Name of the deployment slot to create or update. By default, this API attempts to create or modify the production slot. |
WebSiteData
data
A JSON representation of the app properties. See example. |
System.Threading.CancellationToken
cancellationToken
The cancellation token to use. |
Returns
System.Threading.Tasks.Task<Azure.ResourceManager.ArmOperation<SiteSlotResource>>
|
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}/slots/{slot} Operation Id: WebApps_GetSlot
Declaration
public virtual Azure.Response<bool> Exists (string slot, System.Threading.CancellationToken cancellationToken = null);
Parameters
System.String
slot
Name of the deployment slot. By default, this API returns the production slot. |
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}/slots/{slot} Operation Id: WebApps_GetSlot
Declaration
[System.Diagnostics.DebuggerStepThrough]
public virtual System.Threading.Tasks.Task<Azure.Response<bool>> ExistsAsync (string slot, System.Threading.CancellationToken cancellationToken = null);
Parameters
System.String
slot
Name of the deployment slot. By default, this API returns the production slot. |
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 Gets the details of a web, mobile, or API app. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot} Operation Id: WebApps_GetSlot
Declaration
public virtual Azure.Response<Azure.ResourceManager.AppService.SiteSlotResource> Get (string slot, System.Threading.CancellationToken cancellationToken = null);
Parameters
System.String
slot
Name of the deployment slot. By default, this API returns the production slot. |
System.Threading.CancellationToken
cancellationToken
The cancellation token to use. |
Returns
Azure.Response<SiteSlotResource>
|
Exceptions
System.ArgumentException
|
System.ArgumentNullException
|
GetAll(CancellationToken)
Description for Gets an app's deployment slots. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots Operation Id: WebApps_ListSlots
Declaration
public virtual Azure.Pageable<Azure.ResourceManager.AppService.SiteSlotResource> GetAll (System.Threading.CancellationToken cancellationToken = null);
Parameters
System.Threading.CancellationToken
cancellationToken
The cancellation token to use. |
Returns
Azure.Pageable<SiteSlotResource>
A collection of SiteSlotResource that may take multiple service requests to iterate over. |
GetAllAsync(CancellationToken)
Description for Gets an app's deployment slots. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots Operation Id: WebApps_ListSlots
Declaration
public virtual Azure.AsyncPageable<Azure.ResourceManager.AppService.SiteSlotResource> GetAllAsync (System.Threading.CancellationToken cancellationToken = null);
Parameters
System.Threading.CancellationToken
cancellationToken
The cancellation token to use. |
Returns
Azure.AsyncPageable<SiteSlotResource>
An async collection of SiteSlotResource that may take multiple service requests to iterate over. |
GetAsync(String, CancellationToken)
Description for Gets the details of a web, mobile, or API app. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot} Operation Id: WebApps_GetSlot
Declaration
[System.Diagnostics.DebuggerStepThrough]
public virtual System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.AppService.SiteSlotResource>> GetAsync (string slot, System.Threading.CancellationToken cancellationToken = null);
Parameters
System.String
slot
Name of the deployment slot. By default, this API returns the production slot. |
System.Threading.CancellationToken
cancellationToken
The cancellation token to use. |
Returns
System.Threading.Tasks.Task<Azure.Response<SiteSlotResource>>
|
Exceptions
System.ArgumentException
|
System.ArgumentNullException
|
Explicit Interface Implementations
IAsyncEnumerable<SiteSlotResource>.GetAsyncEnumerator(CancellationToken)
Returns an enumerator that iterates asynchronously through the collection.
Declaration
System.Collections.Generic.IAsyncEnumerator<Azure.ResourceManager.AppService.SiteSlotResource> IAsyncEnumerable<SiteSlotResource>.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<SiteSlotResource>
An enumerator that can be used to iterate asynchronously through the collection. |
IEnumerable<SiteSlotResource>.GetEnumerator()
Returns an enumerator that iterates through the collection.
Declaration
System.Collections.Generic.IEnumerator<Azure.ResourceManager.AppService.SiteSlotResource> IEnumerable<SiteSlotResource>.GetEnumerator ();
Returns
System.Collections.Generic.IEnumerator<SiteSlotResource>
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. |