Migrate prefect-azure docs to Integrations section of the Prefect docs (#12794)

Author: desertaxle

docs/integrations/catalog/prefect-azure.yaml

@@ -1,6 +1,6 @@
 collectionName: prefect-azure
 author: Prefect
 authorUrl: https://prefect.io
-documentation: https://prefecthq.github.io/prefect-azure/
+documentation: prefect-azure
 iconUrl: /img/collections/azure.png
-tag: Azure
+tag: Azure

docs/integrations/prefect-azure/blob_storage.md

@@ -0,0 +1 @@
+::: prefect_azure.blob_storage

docs/integrations/prefect-azure/container_instance.md

@@ -0,0 +1 @@
+::: prefect_azure.container_instance

docs/integrations/prefect-azure/container_instance_worker.md

@@ -0,0 +1 @@
+::: prefect_azure.workers.container_instance

docs/integrations/prefect-azure/cosmos_db.md

@@ -0,0 +1 @@
+::: prefect_azure.cosmos_db

docs/integrations/prefect-azure/credentials.md

@@ -0,0 +1 @@
+::: prefect_azure.credentials

docs/integrations/prefect-azure/deployments/steps.md

@@ -0,0 +1 @@
+::: prefect_azure.deployments.steps

docs/integrations/prefect-azure/index.md

@@ -0,0 +1,144 @@
+# prefect-azure
+
+<p align="center">
+    <a href="https://pypi.python.org/pypi/prefect-azure/" alt="PyPI version">
+        <img alt="PyPI" src="https://img.shields.io/pypi/v/prefect-azure?color=26272B&labelColor=090422"></a>
+    <a href="https://pepy.tech/badge/prefect-azure/" alt="Downloads">
+        <img src="https://img.shields.io/pypi/dm/prefect-azure?color=26272B&labelColor=090422" /></a>
+</p>
+
+`prefect-azure` is a collection of Prefect integrations for orchestration workflows with Azure.
+
+## Getting Started
+
+### Installation
+
+Install `prefect-azure` with `pip`
+
+```bash
+pip install prefect-azure
+```
+
+To use Blob Storage:
+```bash
+pip install "prefect-azure[blob_storage]"
+```
+
+To use Cosmos DB:
+```bash
+pip install "prefect-azure[cosmos_db]"
+```
+
+To use ML Datastore:
+```bash
+pip install "prefect-azure[ml_datastore]"
+```
+
+## Examples
+
+### Download a blob
+
+```python
+from prefect import flow
+
+from prefect_azure import AzureBlobStorageCredentials
+from prefect_azure.blob_storage import blob_storage_download
+
+@flow
+def example_blob_storage_download_flow():
+    connection_string = "connection_string"
+    blob_storage_credentials = AzureBlobStorageCredentials(
+        connection_string=connection_string,
+    )
+    data = blob_storage_download(
+        blob="prefect.txt",
+        container="prefect",
+        azure_credentials=blob_storage_credentials,
+    )
+    return data
+
+example_blob_storage_download_flow()
+```
+
+Use `with_options` to customize options on any existing task or flow:
+```python
+custom_blob_storage_download_flow = example_blob_storage_download_flow.with_options(
+    name="My custom task name",
+    retries=2,
+    retry_delay_seconds=10,
+)
+```
+
+### Run a command on an Azure container instance
+
+```python
+from prefect import flow
+from prefect_azure import AzureContainerInstanceCredentials
+from prefect_azure.container_instance import AzureContainerInstanceJob
+
+
+@flow
+def container_instance_job_flow():
+    aci_credentials = AzureContainerInstanceCredentials.load("MY_BLOCK_NAME")
+    container_instance_job = AzureContainerInstanceJob(
+        aci_credentials=aci_credentials,
+        resource_group_name="azure_resource_group.example.name",
+        subscription_id="<MY_AZURE_SUBSCRIPTION_ID>",
+        command=["echo", "hello world"],
+    )
+    return container_instance_job.run()
+```
+
+### Use Azure Container Instance as infrastructure
+
+If we have `a_flow_module.py`:
+
+```python
+from prefect import flow, get_run_logger
+
+@flow
+def log_hello_flow(name="Marvin"):
+    logger = get_run_logger()
+    logger.info(f"{name} said hello!")
+
+if __name__ == "__main__":
+    log_hello_flow()
+```
+
+We can run that flow using an Azure Container Instance, but first create the infrastructure block:
+
+```python
+from prefect_azure import AzureContainerInstanceCredentials
+from prefect_azure.container_instance import AzureContainerInstanceJob
+
+container_instance_job = AzureContainerInstanceJob(
+    aci_credentials=AzureContainerInstanceCredentials.load("MY_BLOCK_NAME"),
+    resource_group_name="azure_resource_group.example.name",
+    subscription_id="<MY_AZURE_SUBSCRIPTION_ID>",
+)
+container_instance_job.save("aci-dev")
+```
+
+Then, create the deployment either on the UI or through the CLI:
+```bash
+prefect deployment build a_flow_module.py:log_hello_flow --name aci-dev -ib container-instance-job/aci-dev
+```
+
+Visit [Prefect Deployments](https://docs.prefect.io/tutorials/deployments/) for more information about deployments.
+
+## Azure Container Instance Worker
+The Azure Container Instance worker is an excellent way to run 
+your workflows on Azure. 
+
+To get started, create an Azure Container Instances typed work pool:
+```
+prefect work-pool create -t azure-container-instance my-aci-work-pool
+```
+
+Then, run a worker that pulls jobs from the work pool:
+```
+prefect worker start -n my-aci-worker -p my-aci-work-pool
+```
+
+The worker should automatically read the work pool's type and start an 
+Azure Container Instance worker.

docs/integrations/prefect-azure/ml_datastore.md

@@ -0,0 +1 @@
+::: prefect_azure.ml_datastore

mkdocs.yml

@@ -237,6 +237,17 @@ nav:
           - integrations/index.md
           - Using Integrations: integrations/usage.md
           - Contributing Integrations: integrations/contribute.md
+          - Libraries:
+                - Azure:
+                      - integrations/prefect-azure/index.md
+                      - Credentials: integrations/prefect-azure/credentials.md
+                      - Blob Storage: integrations/prefect-azure/blob_storage.md
+                      - Cosmos DB: integrations/prefect-azure/cosmos_db.md
+                      - ML Datastore: integrations/prefect-azure/ml_datastore.md
+                      - Container Instance Block: integrations/prefect-azure/container_instance.md
+                      - Container Instance Worker: integrations/prefect-azure/container_instance_worker.md
+                      - Deployments:
+                            - Steps: integrations/prefect-azure/deployments/steps.md
     - API Reference:
           - api-ref/index.md
           - Python SDK:

netlify.toml

@@ -9,6 +9,7 @@
 base = ""
 command = """
 pip install --upgrade pip \
+&& pip install src/integrations/* \
 && pip install --upgrade --upgrade-strategy eager  -e ".[dev]" \
 && pip install git+https://oauth:${MKDOCS_MATERIAL_INSIDERS_REPO_RO}@github.com/PrefectHQ/mkdocs-material-insiders.git@1471e7595c14a067031600ec18e3cc8d7964e4aa\
 && prefect dev build-docs \

src/integrations/prefect-azure/prefect_azure/container_instance.py

@@ -1,5 +1,4 @@
 """
-<span class="badge-api experimental"/>
 Integrations with the Azure Container Instances service.
 Note this module is experimental. The interfaces within may change without notice.
 
@@ -62,6 +61,7 @@
     )
     ```
 """
+
 import datetime
 import json
 import random
@@ -179,7 +179,6 @@ class AzureContainerInstanceJobResult(InfrastructureResult):
 
 class AzureContainerInstanceJob(Infrastructure):
     """
-    <span class="badge-api experimental"/>
     Run a command using a container on Azure Container Instances.
     Note this block is experimental. The interface may change without notice.
     """

src/integrations/prefect-azure/pyproject.toml

@@ -77,6 +77,7 @@ version_file = "prefect_azure/_version.py"
 root = "../../.."
 tag_regex = "^prefect-azure-(?P<version>\\d+\\.\\d+\\.\\d+)$"
 fallback_version = "0.0.0"
+git_describe_command = 'git describe --dirty --tags --long --match "prefect-azure-*[0-9]*"'
 
 [tool.flake8]
 exclude = [".git", "__pycache__", "build", "dist"]