|
| 1 | +# Azure CLI Site Extension # |
| 2 | +This is an extension to Azure CLI to manage Site resources. |
| 3 | + |
| 4 | +## How to use ## |
| 5 | +Install this extension using the below CLI command |
| 6 | +``` |
| 7 | +az extension add --name site |
| 8 | +``` |
| 9 | +## What is Azure Arc site manager? |
| 10 | +Azure Arc site manager allows you to manage and monitor your on-premises environments as Azure Arc sites. Arc sites are scoped to an Azure resource group, subscription or service group and enable you to track connectivity, alerts, and updates across your environment. The experience is tailored for on-premises scenarios where infrastructure is often managed within a common physical boundary, such as a store, restaurant, or factory. |
| 11 | + |
| 12 | +### Included Features ### |
| 13 | +##### Create a Site at service group scope ##### |
| 14 | + ``` |
| 15 | + az site create --site-name TestSiteName --service-group TestSGName --display-name 'Test Site Display' --description "Test Site" --labels key1="value1" key2="value2" --street-address1="16 TOWNSEND ST" --street-address2="UNIT 1" --city="newyork" --state-or-province="CA" --country="US" --postal-code="94107" |
| 16 | + ``` |
| 17 | + |
| 18 | +##### Create a Site at resource group scope ##### |
| 19 | + ``` |
| 20 | + az site create --site-name TestSiteName --resource-group TestRGName --subscription 000000000-0000-0000-0000-000000000000 --display-name 'Test Site Display' --description "Test Site" --street-address1="16 TOWNSEND ST" --street-address2="UNIT 1" --city="newyork" --state-or-province="CA" --country="US" --postal-code="94107" |
| 21 | + ``` |
| 22 | + |
| 23 | +##### Create a Site at subscription scope ##### |
| 24 | + ``` |
| 25 | + az site create --site-name TestSiteName --subscription 000000000-0000-0000-0000-000000000000 --display-name 'Test Site Display' --description "Test Site" --labels key1="value1" --street-address1="16 TOWNSEND ST" --street-address2="UNIT 1" --city="newyork" --state-or-province="CA" --country="US" --postal-code="94107" |
| 26 | + ``` |
| 27 | + |
| 28 | +##### Delete a Site at service group scope ##### |
| 29 | + ``` |
| 30 | + az site delete --site-name TestSiteName --service-group TestSGName |
| 31 | + ``` |
| 32 | + |
| 33 | +##### Delete a Site at resource group scope ##### |
| 34 | + ``` |
| 35 | + az site delete --site-name TestSiteName --resource-group TestRGName --subscription 00000000-0000-0000-0000-000000000000 |
| 36 | + ``` |
| 37 | + |
| 38 | +##### Delete a Site at subscription scope ##### |
| 39 | + ``` |
| 40 | + az site delete --site-name TestSiteName --subscription 00000000-0000-0000-0000-000000000000 |
| 41 | + ``` |
| 42 | + |
| 43 | +##### List Sites at service group scope ##### |
| 44 | + ``` |
| 45 | + az site list --service-group TestSGName |
| 46 | + ``` |
| 47 | + |
| 48 | +##### List Sites at resource group scope ##### |
| 49 | + ``` |
| 50 | + az site list --resource-group TestRGName --subscription 00000000000-0000-0000-0000-000000000000 |
| 51 | + ``` |
| 52 | + |
| 53 | +##### List Sites at subscription scope ##### |
| 54 | + ``` |
| 55 | + az site list --subscription 00000000000-0000-0000-0000-000000000000 |
| 56 | + ``` |
| 57 | + |
| 58 | +##### Show a Site at service group scope ##### |
| 59 | + ``` |
| 60 | + az site show --site-name TestSiteName --service-group TestSGName |
| 61 | + ``` |
| 62 | + |
| 63 | +##### Show a Site at resource group scope ##### |
| 64 | + ``` |
| 65 | + az site show --site-name TestSiteName --resource-group TestRGName --subscription 00000000-0000-0000-0000-000000000000 |
| 66 | + ``` |
| 67 | + |
| 68 | +##### Show a Site at subscription scope ##### |
| 69 | + ``` |
| 70 | + az site show --site-name TestSiteName --subscription 00000000-0000-0000-0000-000000000000 |
| 71 | + ``` |
| 72 | + |
| 73 | +##### Update a Site at service group scope ##### |
| 74 | + ``` |
| 75 | + az site update --site-name TestSiteName --service-group TestSGName --description "Test Site" --labels key1="value1" key2="value2" --street-address1="17 TOWNSEND ST" --street-address2="UNIT 2" --city="newyork" --state-or-province="CA" --country="US" --postal-code="94107" |
| 76 | + ``` |
| 77 | + |
| 78 | +##### Update a Site at resource group scope ##### |
| 79 | + ``` |
| 80 | + az site update --site-name TestSiteName --resource-group TestMSRG --subscription 00000000-0000-0000-0000-000000000000 --description "Test Site" --labels key1="value1" key2="value2" --street-address1="17 TOWNSEND ST" --street-address2="UNIT 2" --city="newyork" --state-or-province="CA" --country="US" --postal-code="94107" |
| 81 | + ``` |
| 82 | + |
| 83 | +##### Update a Site at subscription scope ##### |
| 84 | + ``` |
| 85 | + az site update --site-name TestSiteName --subscription 00000000-0000-0000-0000-000000000000 --description "Test Site" --labels key1="value1" key2="value2" --street-address1="17 TOWNSEND ST" --street-address2="UNIT 2" --city="newyork" --state-or-province="CA" --country="US" --postal-code="94107" |
| 86 | + ``` |
0 commit comments