azure/Documentation/EnvironmentVariables.md

Microsoft Azure Client Library for node

## Environment Variables Setup


### For clients targeting the ARM (V2) Azure API that are generated using [AutoRest](https://github.com/Azure/autorest) should setup following environment variables:

#### For data plane sdks 
If your service is not following the standanrd Azure AD authentication then please feel free to skip the authentication check by setting the following environment variable:

```
set SKIP_CREDENTIAL_CHECK=true
```

In your test file, you can have

```javascript
var requiredEnvironment = [
  { name: 'AZURE_YOUR_SERVICE_KEY', secure: true }
]; 

// later when instantiating the test suite pass the requiredEnvironment
suite = new SuiteBase(this, testPrefix, requiredEnvironment);
```

#### For management plane sdks make sure to set up the following environment variables
From an admin cmd console/terminal, at the root directory of your cloned repo, run the following for environment setup:
* **Windows**
```
set AZURE_SUBSCRIPTION_ID=<A Guid>
set CLIENT_ID=<A Guid> # Application Id provided by Azure Active Directory (SPN for service principal auth)
set DOMAIN=<A Guid or the domain name of your org> contosoCorp.com
set AZURE_USERNAME=<Your org-id user name> user@contosoCorp.com # Only set this if you are using user authentication
set AZURE_PASSWORD=<Your Password> # Only set this if you are using user authentication
set APPLICATION_SECRET=<Your service principal password or secret> # Only set this if you are using service principal auth
set NOCK_OFF=true
set AZURE_NOCK_RECORD=
```

* **OS X**, **Linux**
```
export AZURE_SUBSCRIPTION_ID=<A Guid>
export CLIENT_ID=<A Guid> # Application Id provided by Azure Active Directory (SPN for service principal auth)
export DOMAIN=<A Guid or the domain name of your org> contosoCorp.com
export AZURE_USERNAME=<Your org-id user name> user@contosoCorp.com # Only set this if you are using user authentication
export AZURE_PASSWORD=<Your Password> # Only set this if you are using user authentication
export APPLICATION_SECRET=<Your service principal password or secret> # Only set this if you are using service principal auth
export NOCK_OFF=true
export AZURE_NOCK_RECORD=
```

### For clients targeting the ASM (V1) Azure API following environment variables need to be setup

From an admin cmd console/terminal, at the root directory of your cloned repo, run the following for environment setup:
* **Windows**
```
set AZURE_APNS_CERTIFICATE_FILE=[path-to-your-certificatefile.pfx] 
set AZURE_APNS_CERTIFICATE_KEY=[your-certificate-key]
set AZURE_CERTIFICATE_FILE=[path-to-your-certificatefile.cer]
set AZURE_CERTIFICATE_KEY_FILE=[path-to-your-certificatefile.pfx]
set AZURE_MPNS_CERTIFICATE_FILE=[path-to-the.pfx]
set AZURE_MPNS_CERTIFICATE_KEY=[certificate-key]
set AZURE_SERVICEBUS_ACCESS_KEY=[your-access-key]
set AZURE_SERVICEBUS_ISSUER=owner 
set AZURE_SERVICEBUS_NAMESPACE=[your-servicebus-namespace]
set AZURE_STORAGE_ACCESS_KEY=[your-storage-account-access-key]
set AZURE_STORAGE_ACCOUNT=[your-storage-account-name]
set AZURE_SUBSCRIPTION_ID=[your-subscripotion-id {a guid}]
set AZURE_MANAGEMENT_HOST=management.core.windows.net
set AZURE_SQL_TEST_LOCATION=West US
set AZURE_STORAGE_DNS_SUFFIX=core.windows.net
set AZURE_SQL_DNS_SUFFIX=core.windows.net
set AZURE_WNS_PACKAGE_SID=package
set AZURE_WNS_SECRET_KEY=key
set AZURE_GCM_KEY=[your-GCMKey]
set NOCK_OFF=true 
```

* **OS X**, **Linux**
```
export AZURE_APNS_CERTIFICATE_FILE=[path-to-your-certificatefile.pfx] 
export AZURE_APNS_CERTIFICATE_KEY=[your-certificate-key]
export AZURE_CERTIFICATE_FILE=[path-to-your-certificatefile.cer]
export AZURE_CERTIFICATE_KEY_FILE=[path-to-your-certificatefile.pfx]
export AZURE_MPNS_CERTIFICATE_FILE=[path-to-the.pfx]
export AZURE_MPNS_CERTIFICATE_KEY=[certificate-key]
export AZURE_SERVICEBUS_ACCESS_KEY=[your-access-key]
export AZURE_SERVICEBUS_ISSUER=owner 
export AZURE_SERVICEBUS_NAMESPACE=[your-servicebus-namespace]
export AZURE_STORAGE_ACCESS_KEY=[your-storage-account-access-key]
export AZURE_STORAGE_ACCOUNT=[your-storage-account-name]
export AZURE_SUBSCRIPTION_ID=[your-subscripotion-id {a guid}]
export AZURE_MANAGEMENT_HOST=management.core.windows.net
export AZURE_SQL_TEST_LOCATION="West US"
export AZURE_STORAGE_DNS_SUFFIX=core.windows.net
export AZURE_SQL_DNS_SUFFIX=core.windows.net
export AZURE_WNS_PACKAGE_SID=package
export AZURE_WNS_SECRET_KEY=key
export AZURE_GCM_KEY=[your-GCMKey]
export NOCK_OFF=true 
```

### For clients targeting any of the Cognitive Services sdks, please make sure to set the corresponding environment variables. Each key is associated with the service that the account was created for.
From an admin cmd console/terminal, at the root directory of your cloned repo, run the following for environment setup:
* **Windows**
```
set AZURE_TEXT_ANALYTICS_KEY=<service-key>
set AZURE_COMPUTER_VISION_KEY=<service-key>
set AZURE_FACE_KEY=<service-key>
set AZURE_ENTITY_SEARCH_KEY=<service-key>
set AZURE_WEB_SEARCH_KEY=<service-key>
set AZURE_VIDEO_SEARCH_KEY=<service-key>
set AZURE_NEWS_SEARCH_KEY=<service-key>
set AZURE_IMAGE_SEARCH_KEY=<service-key>
set AZURE_CUSTOM_SEARCH_KEY=<service-key>
set AZURE_CONTENT_MODERATOR_KEY=<service-key>
```

* **OS X**, **Linux**
```
export AZURE_TEXT_ANALYTICS_KEY=<service-key>
export AZURE_COMPUTER_VISION_KEY=<service-key>
export AZURE_FACE_KEY=<service-key>
export AZURE_ENTITY_SEARCH_KEY=<service-key>
export AZURE_WEB_SEARCH_KEY=<service-key>
export AZURE_VIDEO_SEARCH_KEY=<service-key>
export AZURE_NEWS_SEARCH_KEY=<service-key>
export AZURE_IMAGE_SEARCH_KEY=<service-key>
export AZURE_CUSTOM_SEARCH_KEY=<service-key>
export AZURE_CONTENT_MODERATOR_KEY=<service-key>
```

#### Note: Not all tests require all these environment variables, and if a required one is not set the test will fail and tell you which ones need to be set.