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

Certificates and Domains Management

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

Comprehensive SSL/TLS certificate and custom domain management including certificate provisioning, renewals, bindings, domain registration, and DNS configuration for Azure web services.

Capabilities

SSL/TLS Certificate Management

Manage SSL/TLS certificates for securing web applications with HTTPS endpoints.

def create_or_update(
    resource_group_name: str,
    name: str,
    certificate_envelope: Certificate,
    **kwargs
) -> Certificate:
    """
    Creates or updates an SSL certificate.
    
    Parameters:
    - resource_group_name (str): Name of the resource group
    - name (str): Name of the certificate
    - certificate_envelope (Certificate): Certificate configuration and properties
    
    Returns:
    Certificate: Created or updated certificate resource
    """

def get(
    resource_group_name: str,
    name: str,
    **kwargs
) -> Certificate:
    """
    Gets details of a specific certificate.
    
    Parameters:
    - resource_group_name (str): Name of the resource group
    - name (str): Name of the certificate
    
    Returns:
    Certificate: Certificate details and properties
    """

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

def list(self, **kwargs) -> List[Certificate]:
    """
    Lists all certificates in the subscription.
    
    Returns:
    List[Certificate]: List of certificates
    """

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

def update(
    resource_group_name: str,
    name: str,
    certificate_patch_resource: CertificatePatchResource,
    **kwargs
) -> Certificate:
    """
    Updates an existing certificate.
    
    Parameters:
    - resource_group_name (str): Name of the resource group
    - name (str): Name of the certificate
    - certificate_patch_resource (CertificatePatchResource): Properties to update
    
    Returns:
    Certificate: Updated certificate
    """

Certificate Orders Management

Manage App Service Certificate orders for automated certificate provisioning and lifecycle management.

def begin_create_or_update(
    resource_group_name: str,
    certificate_order_name: str,
    certificate_distinguished_name: AppServiceCertificateOrder,
    **kwargs
) -> LROPoller[AppServiceCertificateOrder]:
    """
    Creates or updates an App Service Certificate order.
    
    Parameters:
    - resource_group_name (str): Name of the resource group
    - certificate_order_name (str): Name of the certificate order
    - certificate_distinguished_name (AppServiceCertificateOrder): Order configuration
    
    Returns:
    LROPoller[AppServiceCertificateOrder]: Long-running operation poller
    """

def get(
    resource_group_name: str,
    certificate_order_name: str,
    **kwargs
) -> AppServiceCertificateOrder:
    """
    Gets details of a certificate order.
    
    Parameters:
    - resource_group_name (str): Name of the resource group
    - certificate_order_name (str): Name of the certificate order
    
    Returns:
    AppServiceCertificateOrder: Certificate order details
    """

def reissue(
    resource_group_name: str,
    certificate_order_name: str,
    reissue_certificate_order_request: ReissueCertificateOrderRequest,
    **kwargs
) -> None:
    """
    Reissues an existing certificate order.
    
    Parameters:
    - resource_group_name (str): Name of the resource group
    - certificate_order_name (str): Name of the certificate order
    - reissue_certificate_order_request (ReissueCertificateOrderRequest): Reissue parameters
    """

def renew(
    resource_group_name: str,
    certificate_order_name: str,
    renew_certificate_order_request: RenewCertificateOrderRequest,
    **kwargs
) -> None:
    """
    Renews an existing certificate order.
    
    Parameters:
    - resource_group_name (str): Name of the resource group
    - certificate_order_name (str): Name of the certificate order
    - renew_certificate_order_request (RenewCertificateOrderRequest): Renewal parameters
    """

Domain Management

Manage custom domains for web applications including domain registration, DNS configuration, and domain verification.

def begin_create_or_update(
    resource_group_name: str,
    domain_name: str,
    domain: Domain,
    **kwargs
) -> LROPoller[Domain]:
    """
    Creates or updates a custom domain registration.
    
    Parameters:
    - resource_group_name (str): Name of the resource group
    - domain_name (str): Name of the domain
    - domain (Domain): Domain configuration and properties
    
    Returns:
    LROPoller[Domain]: Long-running operation poller for domain creation
    """

def get(
    resource_group_name: str,
    domain_name: str,
    **kwargs
) -> Domain:
    """
    Gets details of a specific domain.
    
    Parameters:
    - resource_group_name (str): Name of the resource group
    - domain_name (str): Name of the domain
    
    Returns:
    Domain: Domain details and configuration
    """

def delete(
    resource_group_name: str,
    domain_name: str,
    force_hard_delete_domain: Optional[bool] = None,
    **kwargs
) -> None:
    """
    Deletes a domain registration.
    
    Parameters:
    - resource_group_name (str): Name of the resource group
    - domain_name (str): Name of the domain
    - force_hard_delete_domain (bool, optional): Force permanent deletion
    """

def list(self, **kwargs) -> List[Domain]:
    """
    Lists all domains in the subscription.
    
    Returns:
    List[Domain]: List of domains
    """

def list_ownership_identifiers(
    resource_group_name: str,
    domain_name: str,
    **kwargs
) -> List[DomainOwnershipIdentifier]:
    """
    Lists ownership identifiers for domain verification.
    
    Parameters:
    - resource_group_name (str): Name of the resource group
    - domain_name (str): Name of the domain
    
    Returns:
    List[DomainOwnershipIdentifier]: Domain ownership verification identifiers
    """

def renew(
    resource_group_name: str,
    domain_name: str,
    **kwargs
) -> None:
    """
    Renews a domain registration.
    
    Parameters:
    - resource_group_name (str): Name of the resource group
    - domain_name (str): Name of the domain
    """

Site Certificate Bindings

Manage SSL certificate bindings for web applications and their custom domains.

def create_or_update(
    resource_group_name: str,
    name: str,
    certificate_name: str,
    certificate_envelope: Certificate,
    **kwargs
) -> Certificate:
    """
    Creates or updates a certificate binding for a web app.
    
    Parameters:
    - resource_group_name (str): Name of the resource group
    - name (str): Name of the web app
    - certificate_name (str): Name of the certificate
    - certificate_envelope (Certificate): Certificate binding configuration
    
    Returns:
    Certificate: Certificate binding details
    """

def get(
    resource_group_name: str,
    name: str,
    certificate_name: str,
    **kwargs
) -> Certificate:
    """
    Gets a certificate binding for a web app.
    
    Parameters:
    - resource_group_name (str): Name of the resource group
    - name (str): Name of the web app
    - certificate_name (str): Name of the certificate
    
    Returns:
    Certificate: Certificate binding details
    """

def delete(
    resource_group_name: str,
    name: str,
    certificate_name: str,
    **kwargs
) -> None:
    """
    Removes a certificate binding from a web app.
    
    Parameters:
    - resource_group_name (str): Name of the resource group
    - name (str): Name of the web app
    - certificate_name (str): Name of the certificate
    """

def list(
    resource_group_name: str,
    name: str,
    **kwargs
) -> List[Certificate]:
    """
    Lists certificate bindings for a web app.
    
    Parameters:
    - resource_group_name (str): Name of the resource group
    - name (str): Name of the web app
    
    Returns:
    List[Certificate]: Certificate bindings for the web app
    """

Top-Level Domain Information

Query available top-level domains and their registration requirements.

def list(self, **kwargs) -> List[TopLevelDomain]:
    """
    Lists all available top-level domains.
    
    Returns:
    List[TopLevelDomain]: Available top-level domains
    """

def get(
    name: str,
    **kwargs
) -> TopLevelDomain:
    """
    Gets information about a specific top-level domain.
    
    Parameters:
    - name (str): Name of the top-level domain (e.g., 'com', 'org')
    
    Returns:
    TopLevelDomain: Top-level domain information and requirements
    """

def list_agreements(
    name: str,
    agreement_option: TopLevelDomainAgreementOption,
    **kwargs
) -> List[TldLegalAgreement]:
    """
    Lists legal agreements for a top-level domain.
    
    Parameters:
    - name (str): Name of the top-level domain
    - agreement_option (TopLevelDomainAgreementOption): Agreement options
    
    Returns:
    List[TldLegalAgreement]: Legal agreements for the domain
    """

Types

class Certificate:
    """Represents an SSL certificate resource."""
    id: Optional[str]
    name: Optional[str]
    type: Optional[str]
    location: str
    tags: Optional[Dict[str, str]]
    friendly_name: Optional[str]
    subject_name: Optional[str]
    host_names: Optional[List[str]]
    pfx_blob: Optional[bytes]
    site_name: Optional[str]
    self_link: Optional[str]
    issuer: Optional[str]
    issue_date: Optional[datetime]
    expiration_date: Optional[datetime]
    password: Optional[str]
    thumbprint: Optional[str]
    valid: Optional[bool]
    public_key_hash: Optional[str]
    server_farm_id: Optional[str]
    key_vault_id: Optional[str]
    key_vault_secret_name: Optional[str]
    key_vault_secret_status: Optional[KeyVaultSecretStatus]

class AppServiceCertificateOrder:
    """Represents an App Service certificate order."""
    id: Optional[str]
    name: Optional[str]
    type: Optional[str]
    location: str
    tags: Optional[Dict[str, str]]
    certificates: Optional[Dict[str, AppServiceCertificate]]
    distinguished_name: Optional[str]
    domain_verification_token: Optional[str]
    validity_in_years: Optional[int]
    key_size: Optional[int]
    product_type: CertificateProductType
    auto_renew: Optional[bool]
    provisioning_state: Optional[ProvisioningState]
    status: Optional[CertificateOrderStatus]
    signed_certificate: Optional[CertificateDetails]
    csr: Optional[str]
    intermediate: Optional[CertificateDetails]
    root: Optional[CertificateDetails]
    serial_number: Optional[str]
    last_certificate_issuance_time: Optional[datetime]
    expiration_time: Optional[datetime]
    is_private_key_external: Optional[bool]
    app_service_certificate_not_renewable_reasons: Optional[List[AppServiceCertificateOrderPropertiesAppServiceCertificateNotRenewableReasonsItem]]
    next_auto_renewal_time_stamp: Optional[datetime]
    contact: Optional[CertificateOrderContact]

class Domain:
    """Represents a custom domain resource."""
    id: Optional[str]
    name: Optional[str]
    type: Optional[str]
    location: str
    tags: Optional[Dict[str, str]]
    contact_admin: Contact
    contact_billing: Contact
    contact_registrant: Contact
    contact_tech: Contact
    registration_status: Optional[DomainStatus]
    provisioning_state: Optional[ProvisioningState]
    name_servers: Optional[List[str]]
    privacy: Optional[bool]
    created_time: Optional[datetime]
    expiration_time: Optional[datetime]
    last_renewed_time: Optional[datetime]
    auto_renew: Optional[bool]
    ready_for_dns_record_management: Optional[bool]
    managed_host_names: Optional[List[HostName]]
    consent: DomainPurchaseConsent
    domain_not_renewable_reasons: Optional[List[DomainPropertiesDomainNotRenewableReasonsItem]]
    dns_type: Optional[DnsType]
    dns_zone_id: Optional[str]
    target_dns_type: Optional[DnsType]
    auth_code: Optional[str]

class CertificatePatchResource:
    """Properties for updating a certificate."""
    password: Optional[str]
    host_names: Optional[List[str]]
    server_farm_id: Optional[str]
    key_vault_id: Optional[str]
    key_vault_secret_name: Optional[str]

class DomainOwnershipIdentifier:
    """Domain ownership verification identifier."""
    id: Optional[str]
    name: Optional[str]
    ownership_id: Optional[str]

class TopLevelDomain:
    """Top-level domain information."""
    id: Optional[str]
    name: Optional[str]
    type: Optional[str]
    privacy: Optional[bool]

class Contact:
    """Contact information for domain registration."""
    address_mailing: Optional[Address]
    email: str
    fax: Optional[str]
    job_title: Optional[str]
    name_first: str
    name_last: str
    name_middle: Optional[str]
    organization: Optional[str]
    phone: str

class Address:
    """Mailing address information."""
    address1: str
    address2: Optional[str]
    city: str
    country: str
    postal_code: str
    state: str

class ReissueCertificateOrderRequest:
    """Request for reissuing a certificate order."""
    key_size: Optional[int]
    distinguished_name: Optional[str]
    csr: Optional[str]
    delay_existing_revoke_in_hours: Optional[int]

class RenewCertificateOrderRequest:
    """Request for renewing a certificate order."""
    key_size: Optional[int]
    distinguished_name: Optional[str]
    csr: Optional[str]

Install with Tessl CLI