> ## Documentation Index
> Fetch the complete documentation index at: https://docs.kosli.com/llms.txt
> Use this file to discover all available pages before exploring further.

<AgentInstructions>

## Submitting Feedback

If you encounter incorrect, outdated, or confusing documentation on this page, submit feedback:

POST https://docs.kosli.com/feedback

```json
{
  "path": "/client_reference/kosli_snapshot_azure",
  "feedback": "Description of the issue"
}
```

Only submit feedback when you have something specific and actionable to report.

</AgentInstructions>

# kosli snapshot azure

> Report a snapshot of running Azure web apps and function apps in an Azure resource group to Kosli.  

## Synopsis

```shell theme={"theme":"dracula","languages":{"custom":["/languages/rego.json"]}}
kosli snapshot azure ENVIRONMENT-NAME [flags]
```

Report a snapshot of running Azure web apps and function apps in an Azure resource group to Kosli.
The reported data includes Azure app names, container image digests and creation timestamps.

For Azure Function apps or Web apps which uses zip deployment the fingerprint is calculated based on the
content of the zip file. This is the same as unzipping the file and then running `kosli fingerprint -t dir yourDirName`.
When doing zip deployment the WEBSITE\_RUN\_FROM\_PACKAGE must NOT be set to 1. This will cause the azure
API calls to not return the content of what is running on the server and fingerprint calculations
will not match. See
[https://learn.microsoft.com/en-us/azure/azure-functions/functions-app-settings#website\_run\_from\_package](https://learn.microsoft.com/en-us/azure/azure-functions/functions-app-settings#website_run_from_package)

To authenticate to Azure, you need to create Azure service principal with a secret
and provide these Azure credentials via flags or by exporting the equivalent KOSLI env vars (e.g. KOSLI\_AZURE\_CLIENT\_ID).
The service principal needs to have the following permissions:

1. Microsoft.Web/sites/Read
2. Microsoft.ContainerRegistry/registries/pull/read

## Flags

| Flag                               | Description                                                                                                                          |
| :--------------------------------- | :----------------------------------------------------------------------------------------------------------------------------------- |
| --azure-client-id string           | Azure client ID.                                                                                                                     |
| --azure-client-secret string       | Azure client secret.                                                                                                                 |
| --azure-resource-group-name string | Azure resource group name.                                                                                                           |
| --azure-subscription-id string     | Azure subscription ID.                                                                                                               |
| --azure-tenant-id string           | Azure tenant ID.                                                                                                                     |
| --digests-source string            | \[defaulted] Where to get the digests from. Valid values are 'acr' and 'logs'. (default "acr")                                       |
| -D, --dry-run                      | \[optional] Run in dry-run mode. When enabled, no data is sent to Kosli and the CLI exits with 0 exit code regardless of any errors. |
| -h, --help                         | help for azure                                                                                                                       |
| --zip                              | Download logs from Azure as zip files                                                                                                |

## Flags inherited from parent commands

| Flag                      | Description                                                                                                 |
| :------------------------ | :---------------------------------------------------------------------------------------------------------- |
| -a, --api-token string    | The Kosli API token.                                                                                        |
| -c, --config-file string  | \[optional] The Kosli config file path. (default "kosli")                                                   |
| --debug                   | \[optional] Print debug logs to stdout. A boolean flag [docs](/faq/#boolean-flags) (default false)          |
| -H, --host string         | \[defaulted] The Kosli endpoint. (default "[https://app.kosli.com](https://app.kosli.com)")                 |
| --http-proxy string       | \[optional] The HTTP proxy URL including protocol and port number. e.g. `http://proxy-server-ip:proxy-port` |
| -r, --max-api-retries int | \[defaulted] How many times should API calls be retried when the API host is not reachable. (default 3)     |
| --org string              | The Kosli organization.                                                                                     |

## Examples Use Cases

These examples all assume that the flags  `--api-token`, `--org`, `--host`, (and `--flow`, `--trail` when required), are [set/provided](/getting_started/install/#assigning-flags-via-environment-variables).

<AccordionGroup>
  <Accordion title="Use Azure Container Registry to get the digests for artifacts in a snapshot">
    ```shell theme={"theme":"dracula","languages":{"custom":["/languages/rego.json"]}}
    kosli snapshot azure yourEnvironmentName
    	--azure-client-id yourAzureClientID
    	--azure-client-secret yourAzureClientSecret
    	--azure-tenant-id yourAzureTenantID
    	--azure-subscription-id yourAzureSubscriptionID
    	--azure-resource-group-name yourAzureResourceGroupName
    	--digests-source acr

    ```
  </Accordion>

  <Accordion title="Use Docker logs of Azure apps to get the digests for artifacts in a snapshot">
    ```shell theme={"theme":"dracula","languages":{"custom":["/languages/rego.json"]}}
    kosli snapshot azure yourEnvironmentName
    	--azure-client-id yourAzureClientID
    	--azure-client-secret yourAzureClientSecret
    	--azure-tenant-id yourAzureTenantID
    	--azure-subscription-id yourAzureSubscriptionID
    	--azure-resource-group-name yourAzureResourceGroupName
    	--digests-source logs

    ```
  </Accordion>

  <Accordion title="Report digest of an Azure Function app">
    ```shell theme={"theme":"dracula","languages":{"custom":["/languages/rego.json"]}}
    kosli snapshot azure yourEnvironmentName
    	--azure-client-id yourAzureClientID
    	--azure-client-secret yourAzureClientSecret
    	--azure-tenant-id yourAzureTenantID
    	--azure-subscription-id yourAzureSubscriptionID
    	--azure-resource-group-name yourAzureResourceGroupName
    ```
  </Accordion>
</AccordionGroup>