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

Application Configuration

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

Management of application settings, connection strings, authentication, and site configuration including runtime settings, environment variables, deployment configurations, and security policies for Azure web applications.

Capabilities

Site Configuration Management

Configure runtime settings, framework versions, and platform-specific options for web applications.

def get_configuration(
    resource_group_name: str,
    name: str,
    **kwargs
) -> SiteConfig:
    """
    Gets site configuration for a web app.
    
    Parameters:
    - resource_group_name (str): Name of the resource group
    - name (str): Name of the web app
    
    Returns:
    SiteConfig: Complete site configuration settings
    """

def update_configuration(
    resource_group_name: str,
    name: str,
    site_config: SiteConfig,
    **kwargs
) -> SiteConfig:
    """
    Updates site configuration for a web app.
    
    Parameters:
    - resource_group_name (str): Name of the resource group
    - name (str): Name of the web app
    - site_config (SiteConfig): New site configuration settings
    
    Returns:
    SiteConfig: Updated site configuration
    """

def create_or_update_configuration(
    resource_group_name: str,
    name: str,
    site_config: SiteConfig,
    **kwargs
) -> SiteConfig:
    """
    Creates or updates site configuration for a web app.
    
    Parameters:
    - resource_group_name (str): Name of the resource group
    - name (str): Name of the web app
    - site_config (SiteConfig): Site configuration to create or update
    
    Returns:
    SiteConfig: Created or updated site configuration
    """

def list_configurations(
    resource_group_name: str,
    name: str,
    **kwargs
) -> List[SiteConfigResource]:
    """
    Lists all configuration snapshots for a web app.
    
    Parameters:
    - resource_group_name (str): Name of the resource group
    - name (str): Name of the web app
    
    Returns:
    List[SiteConfigResource]: List of configuration snapshots
    """

Application Settings Management

Manage environment variables and application-specific settings.

def list_application_settings(
    resource_group_name: str,
    name: str,
    **kwargs
) -> StringDictionary:
    """
    Gets application settings for a web app.
    
    Parameters:
    - resource_group_name (str): Name of the resource group
    - name (str): Name of the web app
    
    Returns:
    StringDictionary: Application settings key-value pairs
    """

def update_application_settings(
    resource_group_name: str,
    name: str,
    app_settings: StringDictionary,
    **kwargs
) -> StringDictionary:
    """
    Updates application settings for a web app.
    
    Parameters:
    - resource_group_name (str): Name of the resource group
    - name (str): Name of the web app
    - app_settings (StringDictionary): New application settings
    
    Returns:
    StringDictionary: Updated application settings
    """

def list_application_settings_slot(
    resource_group_name: str,
    name: str,
    slot: str,
    **kwargs
) -> StringDictionary:
    """
    Gets application settings for a deployment slot.
    
    Parameters:
    - resource_group_name (str): Name of the resource group
    - name (str): Name of the web app
    - slot (str): Name of the deployment slot
    
    Returns:
    StringDictionary: Slot-specific application settings
    """

def update_application_settings_slot(
    resource_group_name: str,
    name: str,
    slot: str,
    app_settings: StringDictionary,
    **kwargs
) -> StringDictionary:
    """
    Updates application settings for a deployment slot.
    
    Parameters:
    - resource_group_name (str): Name of the resource group
    - name (str): Name of the web app
    - slot (str): Name of the deployment slot
    - app_settings (StringDictionary): New application settings for the slot
    
    Returns:
    StringDictionary: Updated application settings
    """

Connection Strings Management

Manage database and service connection strings with appropriate security classifications.

def list_connection_strings(
    resource_group_name: str,
    name: str,
    **kwargs
) -> ConnectionStringDictionary:
    """
    Gets connection strings for a web app.
    
    Parameters:
    - resource_group_name (str): Name of the resource group
    - name (str): Name of the web app
    
    Returns:
    ConnectionStringDictionary: Connection strings configuration
    """

def update_connection_strings(
    resource_group_name: str,
    name: str,
    connection_strings: ConnectionStringDictionary,
    **kwargs
) -> ConnectionStringDictionary:
    """
    Updates connection strings for a web app.
    
    Parameters:
    - resource_group_name (str): Name of the resource group
    - name (str): Name of the web app
    - connection_strings (ConnectionStringDictionary): New connection strings
    
    Returns:
    ConnectionStringDictionary: Updated connection strings
    """

def list_connection_strings_slot(
    resource_group_name: str,
    name: str,
    slot: str,
    **kwargs
) -> ConnectionStringDictionary:
    """
    Gets connection strings for a deployment slot.
    
    Parameters:
    - resource_group_name (str): Name of the resource group
    - name (str): Name of the web app
    - slot (str): Name of the deployment slot
    
    Returns:
    ConnectionStringDictionary: Slot-specific connection strings
    """

def update_connection_strings_slot(
    resource_group_name: str,
    name: str,
    slot: str,
    connection_strings: ConnectionStringDictionary,
    **kwargs
) -> ConnectionStringDictionary:
    """
    Updates connection strings for a deployment slot.
    
    Parameters:
    - resource_group_name (str): Name of the resource group
    - name (str): Name of the web app
    - slot (str): Name of the deployment slot
    - connection_strings (ConnectionStringDictionary): New connection strings
    
    Returns:
    ConnectionStringDictionary: Updated connection strings
    """

Authentication and Authorization

Configure authentication providers, authorization policies, and security settings.

def get_auth_settings(
    resource_group_name: str,
    name: str,
    **kwargs
) -> SiteAuthSettings:
    """
    Gets authentication settings for a web app.
    
    Parameters:
    - resource_group_name (str): Name of the resource group
    - name (str): Name of the web app
    
    Returns:
    SiteAuthSettings: Authentication configuration
    """

def update_auth_settings(
    resource_group_name: str,
    name: str,
    site_auth_settings: SiteAuthSettings,
    **kwargs
) -> SiteAuthSettings:
    """
    Updates authentication settings for a web app.
    
    Parameters:
    - resource_group_name (str): Name of the resource group
    - name (str): Name of the web app
    - site_auth_settings (SiteAuthSettings): New authentication settings
    
    Returns:
    SiteAuthSettings: Updated authentication settings
    """

def get_auth_settings_v2(
    resource_group_name: str,
    name: str,
    **kwargs
) -> SiteAuthSettingsV2:
    """
    Gets v2 authentication settings for a web app.
    
    Parameters:
    - resource_group_name (str): Name of the resource group
    - name (str): Name of the web app
    
    Returns:
    SiteAuthSettingsV2: V2 authentication configuration
    """

def update_auth_settings_v2(
    resource_group_name: str,
    name: str,
    site_auth_settings_v2: SiteAuthSettingsV2,
    **kwargs
) -> SiteAuthSettingsV2:
    """
    Updates v2 authentication settings for a web app.
    
    Parameters:
    - resource_group_name (str): Name of the resource group
    - name (str): Name of the web app
    - site_auth_settings_v2 (SiteAuthSettingsV2): New v2 authentication settings
    
    Returns:
    SiteAuthSettingsV2: Updated v2 authentication settings
    """

Metadata and Properties

Manage application metadata and custom properties.

def list_metadata(
    resource_group_name: str,
    name: str,
    **kwargs
) -> StringDictionary:
    """
    Gets metadata for a web app.
    
    Parameters:
    - resource_group_name (str): Name of the resource group
    - name (str): Name of the web app
    
    Returns:
    StringDictionary: Application metadata
    """

def update_metadata(
    resource_group_name: str,
    name: str,
    metadata: StringDictionary,
    **kwargs
) -> StringDictionary:
    """
    Updates metadata for a web app.
    
    Parameters:
    - resource_group_name (str): Name of the resource group
    - name (str): Name of the web app
    - metadata (StringDictionary): New metadata values
    
    Returns:
    StringDictionary: Updated metadata
    """

def get_site_extension(
    resource_group_name: str,
    name: str,
    site_extension_id: str,
    **kwargs
) -> SiteExtensionInfo:
    """
    Gets information about a site extension.
    
    Parameters:
    - resource_group_name (str): Name of the resource group
    - name (str): Name of the web app
    - site_extension_id (str): Site extension identifier
    
    Returns:
    SiteExtensionInfo: Site extension information
    """

def install_site_extension(
    resource_group_name: str,
    name: str,
    site_extension_id: str,
    **kwargs
) -> SiteExtensionInfo:
    """
    Installs a site extension for a web app.
    
    Parameters:
    - resource_group_name (str): Name of the resource group
    - name (str): Name of the web app
    - site_extension_id (str): Site extension identifier
    
    Returns:
    SiteExtensionInfo: Installed site extension information
    """

Types

class SiteConfig:
    """Web app site configuration settings."""
    number_of_workers: Optional[int]
    default_documents: Optional[List[str]]
    net_framework_version: Optional[str]
    php_version: Optional[str]
    python_version: Optional[str]
    node_version: Optional[str]
    power_shell_version: Optional[str]
    linux_fx_version: Optional[str]
    windows_fx_version: Optional[str]
    request_tracing_enabled: Optional[bool]
    request_tracing_expiration_time: Optional[datetime]
    remote_debugging_enabled: Optional[bool]
    remote_debugging_version: Optional[str]
    http_logging_enabled: Optional[bool]
    acr_use_managed_identity_creds: Optional[bool]
    acr_user_managed_identity_id: Optional[str]
    logs_directory_size_limit: Optional[int]
    detailed_error_logging_enabled: Optional[bool]
    publishing_username: Optional[str]
    app_settings: Optional[List[NameValuePair]]
    connection_strings: Optional[List[ConnStringInfo]]
    machine_key: Optional[SiteMachineKey]
    handler_mappings: Optional[List[HandlerMapping]]
    document_root: Optional[str]
    scm_type: Optional[ScmType]
    use32_bit_worker_process: Optional[bool]
    web_sockets_enabled: Optional[bool]
    always_on: Optional[bool]
    java_version: Optional[str]
    java_container: Optional[str]
    java_container_version: Optional[str]
    app_command_line: Optional[str]
    managed_pipeline_mode: Optional[ManagedPipelineMode]
    virtual_applications: Optional[List[VirtualApplication]]
    load_balancing: Optional[SiteLoadBalancing]
    experiments: Optional[Experiments]
    limits: Optional[SiteLimits]
    auto_heal_enabled: Optional[bool]
    auto_heal_rules: Optional[AutoHealRules]
    tracing_options: Optional[str]
    vnet_name: Optional[str]
    vnet_route_all_enabled: Optional[bool]
    vnet_private_ports_count: Optional[int]
    cors: Optional[CorsSettings]
    push: Optional[PushSettings]
    api_definition: Optional[ApiDefinitionInfo]
    api_management_config: Optional[ApiManagementConfig]
    auto_swap_slot_name: Optional[str]
    local_my_sql_enabled: Optional[bool]
    managed_service_identity_id: Optional[int]
    x_managed_service_identity_id: Optional[int]
    key_vault_reference_identity: Optional[str]
    ip_security_restrictions: Optional[List[IpSecurityRestriction]]
    scm_ip_security_restrictions: Optional[List[IpSecurityRestriction]]
    scm_ip_security_restrictions_use_main: Optional[bool]
    http20_enabled: Optional[bool]
    min_tls_version: Optional[SupportedTlsVersions]
    scm_min_tls_version: Optional[SupportedTlsVersions]
    ftps_state: Optional[FtpsState]
    pre_warmed_instance_count: Optional[int]
    function_app_scale_limit: Optional[int]
    health_check_path: Optional[str]
    functions_runtime_scale_monitoring_enabled: Optional[bool]
    website_time_zone: Optional[str]
    minimum_elastic_instance_count: Optional[int]
    azure_storage_accounts: Optional[Dict[str, AzureStorageInfoValue]]
    public_network_access: Optional[str]

class StringDictionary:
    """Dictionary of string key-value pairs."""
    properties: Optional[Dict[str, str]]

class ConnectionStringDictionary:
    """Dictionary of connection strings with type information."""
    properties: Optional[Dict[str, ConnStringValueTypePair]]

class ConnStringValueTypePair:
    """Connection string value and type pair."""
    value: str
    type: ConnectionStringType

class SiteAuthSettings:
    """Authentication settings for a web app."""
    enabled: Optional[bool]
    runtime_version: Optional[str]
    config_version: Optional[str]
    unauthenticated_client_action: Optional[UnauthenticatedClientAction]
    token_store_enabled: Optional[bool]
    allowed_external_redirect_urls: Optional[List[str]]
    default_provider: Optional[BuiltInAuthenticationProvider]
    token_refresh_extension_hours: Optional[float]
    client_id: Optional[str]
    client_secret: Optional[str]
    client_secret_setting_name: Optional[str]
    client_secret_certificate_thumbprint: Optional[str]
    issuer: Optional[str]
    validate_issuer: Optional[bool]
    allowed_audiences: Optional[List[str]]
    additional_login_params: Optional[List[str]]
    aad_claims_authorization: Optional[str]
    google_client_id: Optional[str]
    google_client_secret: Optional[str]
    google_client_secret_setting_name: Optional[str]
    google_oauth_scopes: Optional[List[str]]
    facebook_app_id: Optional[str]
    facebook_app_secret: Optional[str]
    facebook_app_secret_setting_name: Optional[str]
    facebook_oauth_scopes: Optional[List[str]]
    git_hub_client_id: Optional[str]
    git_hub_client_secret: Optional[str]
    git_hub_client_secret_setting_name: Optional[str]
    git_hub_oauth_scopes: Optional[List[str]]
    twitter_consumer_key: Optional[str]
    twitter_consumer_secret: Optional[str]
    twitter_consumer_secret_setting_name: Optional[str]
    microsoft_account_client_id: Optional[str]
    microsoft_account_client_secret: Optional[str]
    microsoft_account_client_secret_setting_name: Optional[str]
    microsoft_account_oauth_scopes: Optional[List[str]]
    is_auth_from_file: Optional[str]
    auth_file_path: Optional[str]

class SiteAuthSettingsV2:
    """V2 authentication settings for a web app."""
    platform: Optional[AuthPlatform]
    global_validation: Optional[GlobalValidation]
    identity_providers: Optional[IdentityProviders]
    login: Optional[Login]
    http_settings: Optional[HttpSettings]

class NameValuePair:
    """Name-value pair for application settings."""
    name: Optional[str]
    value: Optional[str]

class ConnStringInfo:
    """Connection string information."""
    name: Optional[str]
    connection_string: Optional[str]
    type: Optional[ConnectionStringType]

class IpSecurityRestriction:
    """IP security restriction rule."""
    ip_address: Optional[str]
    subnet_mask: Optional[str]
    vnet_subnet_resource_id: Optional[str]
    vnet_traffic_tag: Optional[int]
    subnet_traffic_tag: Optional[int]
    action: Optional[str]
    tag: Optional[IpFilterTag]
    priority: Optional[int]
    name: Optional[str]
    description: Optional[str]
    headers: Optional[Dict[str, List[str]]]

Install with Tessl CLI