tessl/pypi-azure-mgmt-web

Microsoft Azure Web Apps Management Client Library for Python

—

Pending

Quality

Pending

Does it follow best practices?

Impact

Pending

No eval scenarios have been run

Overview

Eval results

Files

App Service Plans Management

Name: tessl/pypi-azure-mgmt-web
Author: tessl

Management of Azure App Service Plans that define the computing resources, scaling options, pricing tiers, and hosting environment for web applications. App Service Plans serve as the foundation for hosting web apps, providing the underlying infrastructure and resource allocation.

Capabilities

App Service Plan Lifecycle

Create, configure, update, and delete App Service Plans with various pricing tiers and resource specifications.

def begin_create_or_update(
    resource_group_name: str,
    name: str,
    app_service_plan: AppServicePlan,
    **kwargs
) -> LROPoller[AppServicePlan]:
    """
    Creates or updates an App Service Plan.
    
    Parameters:
    - resource_group_name (str): Name of the resource group
    - name (str): Name of the App Service Plan
    - app_service_plan (AppServicePlan): Plan configuration and properties
    
    Returns:
    LROPoller[AppServicePlan]: Long-running operation poller for the plan
    """

def get(
    resource_group_name: str,
    name: str,
    **kwargs
) -> AppServicePlan:
    """
    Gets details of a specific App Service Plan.
    
    Parameters:
    - resource_group_name (str): Name of the resource group
    - name (str): Name of the App Service Plan
    
    Returns:
    AppServicePlan: App Service Plan details and configuration
    """

def delete(
    resource_group_name: str,
    name: str,
    **kwargs
) -> None:
    """
    Deletes an App Service Plan.
    
    Parameters:
    - resource_group_name (str): Name of the resource group
    - name (str): Name of the App Service Plan
    """

def list(
    detailed: Optional[bool] = None,
    **kwargs
) -> List[AppServicePlan]:
    """
    Lists all App Service Plans in the subscription.
    
    Parameters:
    - detailed (bool, optional): Include detailed information if true
    
    Returns:
    List[AppServicePlan]: List of all App Service Plans
    """

def list_by_resource_group(
    resource_group_name: str,
    **kwargs
) -> List[AppServicePlan]:
    """
    Lists App Service Plans in a specific resource group.
    
    Parameters:
    - resource_group_name (str): Name of the resource group
    
    Returns:
    List[AppServicePlan]: List of App Service Plans in the resource group
    """

def update(
    resource_group_name: str,
    name: str,
    app_service_plan: AppServicePlanPatchResource,
    **kwargs
) -> AppServicePlan:
    """
    Updates an existing App Service Plan.
    
    Parameters:
    - resource_group_name (str): Name of the resource group
    - name (str): Name of the App Service Plan
    - app_service_plan (AppServicePlanPatchResource): Properties to update
    
    Returns:
    AppServicePlan: Updated App Service Plan
    """

Web Apps Management

Manage web applications within an App Service Plan including listing, restarting, and resource operations.

def list_web_apps(
    resource_group_name: str,
    name: str,
    skip_token: Optional[str] = None,
    filter: Optional[str] = None,
    top: Optional[str] = None,
    **kwargs
) -> List[Site]:
    """
    Lists web apps in an App Service Plan.
    
    Parameters:
    - resource_group_name (str): Name of the resource group
    - name (str): Name of the App Service Plan
    - skip_token (str, optional): Continuation token for paging
    - filter (str, optional): OData filter expression
    - top (str, optional): Maximum number of results to return
    
    Returns:
    List[Site]: List of web apps in the plan
    """

def restart_web_apps(
    resource_group_name: str,
    name: str,
    soft_restart: Optional[bool] = None,
    **kwargs
) -> None:
    """
    Restarts all web apps in an App Service Plan.
    
    Parameters:
    - resource_group_name (str): Name of the resource group
    - name (str): Name of the App Service Plan
    - soft_restart (bool, optional): Perform soft restart if true
    """

Plan Capabilities and Resources

Query available capabilities, SKUs, and resource utilization for App Service Plans.

def list_capabilities(
    resource_group_name: str,
    name: str,
    **kwargs
) -> List[Capability]:
    """
    Lists capabilities available for an App Service Plan.
    
    Parameters:
    - resource_group_name (str): Name of the resource group
    - name (str): Name of the App Service Plan
    
    Returns:
    List[Capability]: Available capabilities and features
    """

def list_usages(
    resource_group_name: str,
    name: str,
    filter: Optional[str] = None,
    **kwargs
) -> List[CsmUsageQuota]:
    """
    Lists usage metrics for an App Service Plan.
    
    Parameters:
    - resource_group_name (str): Name of the resource group
    - name (str): Name of the App Service Plan
    - filter (str, optional): OData filter for specific metrics
    
    Returns:
    List[CsmUsageQuota]: Usage metrics and quotas
    """

def get_server_farm_skus(
    resource_group_name: str,
    name: str,
    **kwargs
) -> List[Object]:
    """
    Gets available SKUs for upgrading an App Service Plan.
    
    Parameters:
    - resource_group_name (str): Name of the resource group
    - name (str): Name of the App Service Plan
    
    Returns:
    List[Object]: Available SKUs for the plan
    """

Worker Management

Manage worker instances within an App Service Plan including rebooting and scaling operations.

def reboot_worker(
    resource_group_name: str,
    name: str,
    worker_name: str,
    **kwargs
) -> None:
    """
    Reboots a worker instance in an App Service Plan.
    
    Parameters:
    - resource_group_name (str): Name of the resource group
    - name (str): Name of the App Service Plan
    - worker_name (str): Name of the worker instance to reboot
    """

def list_workers(
    resource_group_name: str,
    name: str,
    **kwargs
) -> List[WorkerPool]:
    """
    Lists worker pools for an App Service Plan.
    
    Parameters:
    - resource_group_name (str): Name of the resource group
    - name (str): Name of the App Service Plan
    
    Returns:
    List[WorkerPool]: Worker pools in the plan
    """

Virtual Network Integration

Manage virtual network integration and hybrid connections for App Service Plans.

def list_vnet_connections(
    resource_group_name: str,
    name: str,
    **kwargs
) -> List[VnetInfo]:
    """
    Lists virtual network connections for an App Service Plan.
    
    Parameters:
    - resource_group_name (str): Name of the resource group
    - name (str): Name of the App Service Plan
    
    Returns:
    List[VnetInfo]: Virtual network connections
    """

def get_vnet_from_server_farm(
    resource_group_name: str,
    name: str,
    vnet_name: str,
    **kwargs
) -> VnetInfo:
    """
    Gets virtual network connection details for an App Service Plan.
    
    Parameters:
    - resource_group_name (str): Name of the resource group
    - name (str): Name of the App Service Plan
    - vnet_name (str): Name of the virtual network
    
    Returns:
    VnetInfo: Virtual network connection details
    """

def list_hybrid_connections(
    resource_group_name: str,
    name: str,
    **kwargs
) -> List[HybridConnection]:
    """
    Lists hybrid connections for an App Service Plan.
    
    Parameters:
    - resource_group_name (str): Name of the resource group
    - name (str): Name of the App Service Plan
    
    Returns:
    List[HybridConnection]: Hybrid connections configuration
    """

Types

class AppServicePlan:
    """Represents an App Service plan resource."""
    id: Optional[str]
    name: Optional[str]
    type: Optional[str]
    location: str
    tags: Optional[Dict[str, str]]
    sku: Optional[SkuDescription]
    worker_tier_name: Optional[str]
    status: Optional[StatusOptions]
    subscription: Optional[str]
    hosting_environment_profile: Optional[HostingEnvironmentProfile]
    maximum_number_of_workers: Optional[int]
    geo_region: Optional[str]
    per_site_scaling: Optional[bool]
    maximum_elastic_worker_count: Optional[int]
    number_of_sites: Optional[int]
    is_spot: Optional[bool]
    spot_expiration_time: Optional[datetime]
    free_offer_expiration_time: Optional[datetime]
    resource_group: Optional[str]
    reserved: Optional[bool]
    is_xenon: Optional[bool]
    hyper_v: Optional[bool]
    target_worker_count: Optional[int]
    target_worker_size_id: Optional[int]

class SkuDescription:
    """SKU description for App Service Plan."""
    name: Optional[str]
    tier: Optional[str]
    size: Optional[str]
    family: Optional[str]
    capacity: Optional[int]
    sku_capacity: Optional[SkuCapacity]
    locations: Optional[List[str]]
    location_info: Optional[List[ResourceSkuLocationInfo]]
    capabilities: Optional[List[Capability]]

class SkuCapacity:
    """SKU capacity information."""
    minimum: Optional[int]
    maximum: Optional[int]
    elastic_maximum: Optional[int]
    default: Optional[int]
    scale_type: Optional[str]

class HostingEnvironmentProfile:
    """App Service Environment profile."""
    id: Optional[str]
    name: Optional[str]
    type: Optional[str]

class AppServicePlanPatchResource:
    """Properties for updating an App Service Plan."""
    sku: Optional[SkuDescription]
    worker_tier_name: Optional[str]
    per_site_scaling: Optional[bool]
    maximum_elastic_worker_count: Optional[int]
    is_spot: Optional[bool]
    spot_expiration_time: Optional[datetime]
    free_offer_expiration_time: Optional[datetime]
    reserved: Optional[bool]
    is_xenon: Optional[bool]
    hyper_v: Optional[bool]
    target_worker_count: Optional[int]
    target_worker_size_id: Optional[int]

class Capability:
    """Capability information."""
    name: Optional[str]
    value: Optional[str]
    reason: Optional[str]

class CsmUsageQuota:
    """Usage quota information."""
    unit: Optional[str]
    next_reset_time: Optional[datetime]
    current_value: Optional[int]
    limit: Optional[int]
    name: Optional[LocalizableString]

class LocalizableString:
    """Localizable string."""
    value: Optional[str]
    localized_value: Optional[str]

class WorkerPool:
    """Worker pool information."""
    worker_size_code: Optional[int]
    worker_size: Optional[str]
    worker_count: Optional[int]
    instance_names: Optional[List[str]]

class VnetInfo:
    """Virtual network information."""
    vnet_resource_id: Optional[str]
    cert_blob: Optional[str]
    dns_servers: Optional[str]
    is_swift: Optional[bool]

class HybridConnection:
    """Hybrid connection information."""
    entity_name: Optional[str]
    entity_connection_string: Optional[str]
    resource_type: Optional[str]
    resource_connection_string: Optional[str]
    hostname: Optional[str]
    port: Optional[int]
    biztalk_uri: Optional[str]

Install with Tessl CLI