|
| 1 | +<!-- region Generated --> |
| 2 | +# Az.Site |
| 3 | +This directory contains the PowerShell module for the Site service. |
| 4 | + |
| 5 | +--- |
| 6 | +## Info |
| 7 | +- Modifiable: yes |
| 8 | +- Generated: all |
| 9 | +- Committed: yes |
| 10 | +- Packaged: yes |
| 11 | + |
| 12 | +--- |
| 13 | +## Detail |
| 14 | +This module was primarily generated via [AutoRest](https://github.com/Azure/autorest) using the [PowerShell](https://github.com/Azure/autorest.powershell) extension. |
| 15 | + |
| 16 | +## Module Requirements |
| 17 | +- [Az.Accounts module](https://www.powershellgallery.com/packages/Az.Accounts/), version 2.7.5 or greater |
| 18 | + |
| 19 | +## Authentication |
| 20 | +AutoRest does not generate authentication code for the module. Authentication is handled via Az.Accounts by altering the HTTP payload before it is sent. |
| 21 | + |
| 22 | +## Development |
| 23 | +For information on how to develop for `Az.Site`, see [how-to.md](how-to.md). |
| 24 | +<!-- endregion --> |
| 25 | + |
| 26 | +<!-- region Generated --> |
| 27 | +# Az.Site |
| 28 | +This directory contains the PowerShell module for the Site service. |
| 29 | + |
| 30 | +### AutoRest Configuration |
| 31 | +> see https://aka.ms/autorest |
| 32 | +
|
| 33 | +``` yaml |
| 34 | +require: |
| 35 | +# readme.azure.noprofile.md is the common configuration file |
| 36 | + - $(this-folder)/../../readme.azure.noprofile.md |
| 37 | +input-file: |
| 38 | +# You need to specify your swagger files here. |
| 39 | + - $(repo)/specification/edge/resource-manager/Microsoft.Edge/sites/stable/2025-06-01/sites.json |
| 40 | + |
| 41 | +commit: 3d1eea900f369f1a655c9bbb4fff4bf4657a7d75 |
| 42 | +# If the swagger has not been put in the repo, you may uncomment the following line and refer to it locally |
| 43 | +# - (this-folder)/relative-path-to-your-swagger |
| 44 | + |
| 45 | +# For new RP, the version is 0.1.0 |
| 46 | +module-version: 0.1.0 |
| 47 | +# Normally, title is the service name |
| 48 | +title: Site |
| 49 | +inlining-threshold: 50 |
| 50 | + |
| 51 | +directive: |
| 52 | + # Following are common directives which are normally required in all the RPs |
| 53 | + # 1. Remove the unexpanded parameter set |
| 54 | + # 2. For New-* cmdlets, ViaIdentity is not required |
| 55 | + # Following two directives are v4 specific |
| 56 | + - where: |
| 57 | + variant: ^(Create|Update|CreateViaIdentity|CreateViaIdentityExpanded|UpdateViaIdentity)(?!.*?(Expanded|JsonFilePath|JsonString)) |
| 58 | + remove: true |
| 59 | + # Follow directive is v3 specific. If you are using v3, uncomment following directive and comments out two directives above |
| 60 | + #- where: |
| 61 | + # variant: ^Create$|^CreateViaIdentity$|^CreateViaIdentityExpanded$|^Update$|^UpdateViaIdentity$ |
| 62 | + # remove: true |
| 63 | + |
| 64 | + # Remove the set-* cmdlet |
| 65 | + - where: |
| 66 | + verb: Set |
| 67 | + remove: true |
| 68 | + |
| 69 | + # Hide ALL scope-specific cmdlets to allow custom unified cmdlets |
| 70 | + - where: |
| 71 | + subject: SitesBySubscription |
| 72 | + hide: true |
| 73 | + - where: |
| 74 | + subject: SitesByServiceGroup |
| 75 | + hide: true |
| 76 | + |
| 77 | + # Hide ALL base resource group scope cmdlets (our custom unified cmdlets replace them) |
| 78 | + - where: |
| 79 | + verb: Get |
| 80 | + subject: Site |
| 81 | + hide: true |
| 82 | + - where: |
| 83 | + verb: New |
| 84 | + subject: Site |
| 85 | + hide: true |
| 86 | + - where: |
| 87 | + verb: Remove |
| 88 | + subject: Site |
| 89 | + hide: true |
| 90 | + - where: |
| 91 | + verb: Update |
| 92 | + subject: Site |
| 93 | + hide: true |
| 94 | + |
| 95 | + # Parameter customizations for better user experience |
| 96 | + - where: |
| 97 | + parameter-name: Label |
| 98 | + set: |
| 99 | + parameter-name: Labels |
| 100 | + |
| 101 | + # Remove SiteAddress prefix from address-related parameters |
| 102 | + - where: |
| 103 | + parameter-name: SiteAddressCity |
| 104 | + set: |
| 105 | + parameter-name: City |
| 106 | + |
| 107 | + - where: |
| 108 | + parameter-name: SiteAddressCountry |
| 109 | + set: |
| 110 | + parameter-name: Country |
| 111 | + |
| 112 | + - where: |
| 113 | + parameter-name: SiteAddressPostalCode |
| 114 | + set: |
| 115 | + parameter-name: PostalCode |
| 116 | + |
| 117 | + - where: |
| 118 | + parameter-name: SiteAddressStateOrProvince |
| 119 | + set: |
| 120 | + parameter-name: StateOrProvince |
| 121 | + |
| 122 | + - where: |
| 123 | + parameter-name: SiteAddressStreetAddress1 |
| 124 | + set: |
| 125 | + parameter-name: StreetAddress1 |
| 126 | + |
| 127 | + - where: |
| 128 | + parameter-name: SiteAddressStreetAddress2 |
| 129 | + set: |
| 130 | + parameter-name: StreetAddress2 |
| 131 | + |
| 132 | + - where: |
| 133 | + property-name: Label |
| 134 | + set: |
| 135 | + property-name: Labels |
| 136 | + |
| 137 | + # Remove Address prefix from address-related properties |
| 138 | + - where: |
| 139 | + property-name: AddressCity |
| 140 | + set: |
| 141 | + property-name: City |
| 142 | + |
| 143 | + - where: |
| 144 | + property-name: AddressCountry |
| 145 | + set: |
| 146 | + property-name: Country |
| 147 | + |
| 148 | + - where: |
| 149 | + property-name: AddressPostalCode |
| 150 | + set: |
| 151 | + property-name: PostalCode |
| 152 | + |
| 153 | + - where: |
| 154 | + property-name: AddressStateOrProvince |
| 155 | + set: |
| 156 | + property-name: StateOrProvince |
| 157 | + |
| 158 | + - where: |
| 159 | + property-name: AddressStreetAddress1 |
| 160 | + set: |
| 161 | + property-name: StreetAddress1 |
| 162 | + |
| 163 | + - where: |
| 164 | + property-name: AddressStreetAddress2 |
| 165 | + set: |
| 166 | + property-name: StreetAddress2 |
| 167 | + |
| 168 | + - where: |
| 169 | + parameter-name: SiteName |
| 170 | + set: |
| 171 | + alias: Name |
| 172 | + |
| 173 | +``` |
0 commit comments