WebSiteCollection Class

Definition

A class representing a collection of WebSiteResource and their operations. Each WebSiteResource in the collection will belong to the same instance of ResourceGroupResource. To get a WebSiteCollection instance call the GetWebSites method from an instance of ResourceGroupResource.

public class WebSiteCollection : Azure.ResourceManager.ArmCollection, System.Collections.Generic.IAsyncEnumerable<Azure.ResourceManager.AppService.WebSiteResource>, System.Collections.Generic.IEnumerable<Azure.ResourceManager.AppService.WebSiteResource>
type WebSiteCollection = class
    inherit ArmCollection
    interface seq<WebSiteResource>
    interface IEnumerable
    interface IAsyncEnumerable<WebSiteResource>
Public Class WebSiteCollection
Inherits ArmCollection
Implements IAsyncEnumerable(Of WebSiteResource), IEnumerable(Of WebSiteResource)
Inheritance
WebSiteCollection
Implements

Constructors

WebSiteCollection()

Initializes a new instance of the WebSiteCollection class for mocking.

Properties

Client

Gets the ArmClient this resource client was created from.

(Inherited from ArmCollection)
Diagnostics

Gets the diagnostic options for this resource client.

(Inherited from ArmCollection)
Endpoint

Gets the base uri for this resource client.

(Inherited from ArmCollection)
Id

Gets the resource identifier.

(Inherited from ArmCollection)
Pipeline

Gets the pipeline for this resource client.

(Inherited from ArmCollection)

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}
  • Operation Id: WebApps_CreateOrUpdate
  • Default Api Version: 2023-12-01
  • Resource: WebSiteResource
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}
  • Operation Id: WebApps_CreateOrUpdate
  • Default Api Version: 2023-12-01
  • Resource: WebSiteResource
Exists(String, CancellationToken)

Checks to see if the resource exists in azure.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}
  • Operation Id: WebApps_Get
  • Default Api Version: 2023-12-01
  • Resource: WebSiteResource
ExistsAsync(String, CancellationToken)

Checks to see if the resource exists in azure.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}
  • Operation Id: WebApps_Get
  • Default Api Version: 2023-12-01
  • Resource: WebSiteResource
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}
  • Operation Id: WebApps_Get
  • Default Api Version: 2023-12-01
  • Resource: WebSiteResource
GetAll(Nullable<Boolean>, CancellationToken)

Description for Gets all web, mobile, and API apps in the specified resource group.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites
  • Operation Id: WebApps_ListByResourceGroup
  • Default Api Version: 2023-12-01
  • Resource: WebSiteResource
GetAllAsync(Nullable<Boolean>, CancellationToken)

Description for Gets all web, mobile, and API apps in the specified resource group.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites
  • Operation Id: WebApps_ListByResourceGroup
  • Default Api Version: 2023-12-01
  • Resource: WebSiteResource
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}
  • Operation Id: WebApps_Get
  • Default Api Version: 2023-12-01
  • Resource: WebSiteResource
GetIfExists(String, CancellationToken)

Tries to get details for this resource from the service.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}
  • Operation Id: WebApps_Get
  • Default Api Version: 2023-12-01
  • Resource: WebSiteResource
GetIfExistsAsync(String, CancellationToken)

Tries to get details for this resource from the service.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}
  • Operation Id: WebApps_Get
  • Default Api Version: 2023-12-01
  • Resource: WebSiteResource
TryGetApiVersion(ResourceType, String)

Gets the api version override if it has been set for the current client options.

(Inherited from ArmCollection)

Explicit Interface Implementations

IAsyncEnumerable<WebSiteResource>.GetAsyncEnumerator(CancellationToken)

Returns an enumerator that iterates asynchronously through the collection.

IEnumerable.GetEnumerator()

Returns an enumerator that iterates through a collection.

IEnumerable<WebSiteResource>.GetEnumerator()

Returns an enumerator that iterates through the collection.

Applies to