-
Notifications
You must be signed in to change notification settings - Fork 3.9k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Change module name from Az.HealthDeidentification to Az.HealthDataAiS…
…ervices (#26489) * Ai * Examples * Directives * Docs * Tests * Update README.md * Fix AI capitalization issue --------- Co-authored-by: Alexa Thomases <[email protected]>
- Loading branch information
1 parent
c883d30
commit 5ff1f9a
Showing
33 changed files
with
4,120 additions
and
0 deletions.
There are no files selected for viewing
1 change: 1 addition & 0 deletions
1
src/HealthDataAIServices/HealthDataAIServices.Autorest/.gitattributes
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
* text=auto |
18 changes: 18 additions & 0 deletions
18
src/HealthDataAIServices/HealthDataAIServices.Autorest/.gitignore
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,18 @@ | ||
bin | ||
obj | ||
.vs | ||
generated | ||
internal | ||
exports | ||
tools | ||
custom/*.psm1 | ||
custom/autogen-model-cmdlets | ||
test/*-TestResults.xml | ||
license.txt | ||
/*.ps1 | ||
/*.psd1 | ||
/*.ps1xml | ||
/*.psm1 | ||
/*.snk | ||
/*.csproj | ||
/*.nuspec |
26 changes: 26 additions & 0 deletions
26
src/HealthDataAIServices/HealthDataAIServices.Autorest/Properties/AssemblyInfo.cs
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,26 @@ | ||
// Copyright (c) Microsoft Corporation. All rights reserved. | ||
// Licensed under the Apache License, Version 2.0 (the ""License""); | ||
// you may not use this file except in compliance with the License. | ||
// You may obtain a copy of the License at | ||
// http://www.apache.org/licenses/LICENSE-2.0 | ||
// Unless required by applicable law or agreed to in writing, software | ||
// distributed under the License is distributed on an ""AS IS"" BASIS, | ||
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
// See the License for the specific language governing permissions and | ||
// limitations under the License. | ||
// Code generated by Microsoft (R) AutoRest Code Generator.Changes may cause incorrect behavior and will be lost if the code | ||
// is regenerated. | ||
|
||
using System; | ||
using System.Reflection; | ||
using System.Runtime.CompilerServices; | ||
using System.Runtime.InteropServices; | ||
|
||
[assembly: System.Reflection.AssemblyCompanyAttribute("Microsoft")] | ||
[assembly: System.Reflection.AssemblyCopyrightAttribute("Copyright © Microsoft")] | ||
[assembly: System.Reflection.AssemblyProductAttribute("Microsoft Azure PowerShell")] | ||
[assembly: System.Reflection.AssemblyTitleAttribute("Microsoft Azure PowerShell - HealthDataAiServices")] | ||
[assembly: System.Reflection.AssemblyFileVersionAttribute("0.1.0.0")] | ||
[assembly: System.Reflection.AssemblyVersionAttribute("0.1.0.0")] | ||
[assembly: System.Runtime.InteropServices.ComVisibleAttribute(false)] | ||
[assembly: System.CLSCompliantAttribute(false)] |
80 changes: 80 additions & 0 deletions
80
src/HealthDataAIServices/HealthDataAIServices.Autorest/README.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,80 @@ | ||
<!-- region Generated --> | ||
# Az.HealthDataAIServices | ||
This directory contains the PowerShell module for the HealthDataAiServices service. | ||
|
||
--- | ||
## Info | ||
- Modifiable: yes | ||
- Generated: all | ||
- Committed: yes | ||
- Packaged: yes | ||
|
||
--- | ||
## Detail | ||
This module was primarily generated via [AutoRest](https://github.com/Azure/autorest) using the [PowerShell](https://github.com/Azure/autorest.powershell) extension. | ||
|
||
## Module Requirements | ||
- [Az.Accounts module](https://www.powershellgallery.com/packages/Az.Accounts/), version 2.7.5 or greater | ||
|
||
## Authentication | ||
AutoRest does not generate authentication code for the module. Authentication is handled via Az.Accounts by altering the HTTP payload before it is sent. | ||
|
||
## Development | ||
For information on how to develop for `Az.HealthDataAIServices`, see [how-to.md](how-to.md). | ||
<!-- endregion --> | ||
|
||
### AutoRest Configuration | ||
> see https://aka.ms/autorest | ||
```yaml | ||
# pin the swagger version by using the commit id instead of branch name | ||
commit: cde61328a54d392000b36882fec169fce5a983c1 | ||
tag: package-2024-02-28-preview | ||
require: | ||
# readme.azure.noprofile.md is the common configuration file | ||
- $(this-folder)/../../readme.azure.noprofile.md | ||
- $(repo)/specification/healthdataaiservices/resource-manager/readme.md | ||
# If the swagger has not been put in the repo, you may uncomment the following line and refer to it locally | ||
# - (this-folder)/relative-path-to-your-local-readme.md | ||
|
||
try-require: | ||
- $(repo)/specification/healthdataaiservices/resource-manager/readme.powershell.md | ||
|
||
# For new RP, the version is 0.1.0 | ||
module-version: 0.1.0 | ||
# Normally, title is the service name | ||
title: HealthDataAIServices | ||
subject-prefix: Deid | ||
service-name: HealthDataAIServices | ||
|
||
# The next three configurations are exclusive to v3, and in v4, they are activated by default. If you are still using v3, please uncomment them. | ||
# identity-correction-for-post: true | ||
# resourcegroup-append: true | ||
# nested-object-to-string: true | ||
|
||
directive: | ||
# Following are common directives which are normally required in all the RPs | ||
# 1. Remove the unexpanded parameter set | ||
# 2. For New-* cmdlets, ViaIdentity is not required | ||
# Following two directives are v4 specific | ||
- where: | ||
variant: ^(Create|Update)(?!.*?(Expanded|JsonFilePath|JsonString)) | ||
remove: true | ||
- where: | ||
variant: ^CreateViaIdentity.*$ | ||
remove: true | ||
# Remove cmdlet for PrivateLink resource | ||
- where: | ||
subject: .*PrivateLink.* | ||
remove: true | ||
|
||
# Follow directive is v3 specific. If you are using v3, uncomment following directive and comments out two directives above | ||
#- where: | ||
# variant: ^Create$|^CreateViaIdentity$|^CreateViaIdentityExpanded$|^Update$|^UpdateViaIdentity$ | ||
# remove: true | ||
|
||
# Remove the set-* cmdlet | ||
- where: | ||
verb: Set | ||
remove: true | ||
``` |
85 changes: 85 additions & 0 deletions
85
...ervices/HealthDataAIServices.Autorest/UX/Microsoft.HealthDataAIServices/deidServices.json
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,85 @@ | ||
{ | ||
"resourceType": "deidServices", | ||
"apiVersion": "2024-02-28-preview", | ||
"learnMore": { | ||
"url": "https://learn.microsoft.com/powershell/module/az.healthdataaiservices" | ||
}, | ||
"commands": [ | ||
{ | ||
"name": "Get-AzDeidService", | ||
"description": "Get a DeidService", | ||
"path": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthDataAIServices/deidServices/{deidServiceName}", | ||
"help": { | ||
"learnMore": { | ||
"url": "https://learn.microsoft.com/powershell/module/az.healthdataaiservices/get-azdeidservice" | ||
}, | ||
"parameterSets": [ | ||
{ | ||
"parameters": [ | ||
"-Name <String>", | ||
"-ResourceGroupName <String>", | ||
"[-SubscriptionId <String[]>]" | ||
] | ||
} | ||
] | ||
}, | ||
"examples": [ | ||
{ | ||
"description": "Get a DeidService", | ||
"parameters": [ | ||
{ | ||
"name": "-Name", | ||
"value": "[Path.deidServiceName]" | ||
}, | ||
{ | ||
"name": "-ResourceGroupName", | ||
"value": "[Path.resourceGroupName]" | ||
}, | ||
{ | ||
"name": "-SubscriptionId", | ||
"value": "[Path.subscriptionId]" | ||
} | ||
] | ||
} | ||
] | ||
}, | ||
{ | ||
"name": "Remove-AzDeidService", | ||
"description": "Delete a DeidService", | ||
"path": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthDataAIServices/deidServices/{deidServiceName}", | ||
"help": { | ||
"learnMore": { | ||
"url": "https://learn.microsoft.com/powershell/module/az.healthdataaiservices/remove-azdeidservice" | ||
}, | ||
"parameterSets": [ | ||
{ | ||
"parameters": [ | ||
"-Name <String>", | ||
"-ResourceGroupName <String>", | ||
"[-SubscriptionId <String>]" | ||
] | ||
} | ||
] | ||
}, | ||
"examples": [ | ||
{ | ||
"description": "Delete a DeidService", | ||
"parameters": [ | ||
{ | ||
"name": "-Name", | ||
"value": "[Path.deidServiceName]" | ||
}, | ||
{ | ||
"name": "-ResourceGroupName", | ||
"value": "[Path.resourceGroupName]" | ||
}, | ||
{ | ||
"name": "-SubscriptionId", | ||
"value": "[Path.subscriptionId]" | ||
} | ||
] | ||
} | ||
] | ||
} | ||
] | ||
} |
41 changes: 41 additions & 0 deletions
41
src/HealthDataAIServices/HealthDataAIServices.Autorest/custom/README.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,41 @@ | ||
# Custom | ||
This directory contains custom implementation for non-generated cmdlets for the `Az.HealthDataAIServices` module. Both scripts (`.ps1`) and C# files (`.cs`) can be implemented here. They will be used during the build process in `build-module.ps1`, and create cmdlets into the `../exports` folder. The only generated file into this folder is the `Az.HealthDataAIServices.custom.psm1`. This file should not be modified. | ||
|
||
## Info | ||
- Modifiable: yes | ||
- Generated: partial | ||
- Committed: yes | ||
- Packaged: yes | ||
|
||
## Details | ||
For `Az.HealthDataAIServices` to use custom cmdlets, it does this two different ways. We **highly recommend** creating script cmdlets, as they are easier to write and allow access to the other exported cmdlets. C# cmdlets *cannot access exported cmdlets*. | ||
|
||
For C# cmdlets, they are compiled with the rest of the generated low-level cmdlets into the `./bin/Az.HealthDataAIServices.private.dll`. The names of the cmdlets (methods) and files must follow the `[cmdletName]_[variantName]` syntax used for generated cmdlets. The `variantName` is used as the `ParameterSetName`, so use something appropriate that doesn't clash with already created variant or parameter set names. You cannot use the `ParameterSetName` property in the `Parameter` attribute on C# cmdlets. Each cmdlet must be separated into variants using the same pattern as seen in the `generated/cmdlets` folder. | ||
|
||
For script cmdlets, these are loaded via the `Az.HealthDataAIServices.custom.psm1`. Then, during the build process, this module is loaded and processed in the same manner as the C# cmdlets. The fundamental difference is the script cmdlets use the `ParameterSetName` attribute and C# cmdlets do not. To create a script cmdlet variant of a generated cmdlet, simply decorate all parameters in the script with the new `ParameterSetName` in the `Parameter` attribute. This will appropriately treat each parameter set as a separate variant when processed to be exported during the build. | ||
|
||
## Purpose | ||
This allows the modules to have cmdlets that were not defined in the REST specification. It also allows combining logic using generated cmdlets. This is a level of customization beyond what can be done using the [readme configuration options](https://github.com/Azure/autorest/blob/master/docs/powershell/options.md) that are currently available. These custom cmdlets are then referenced by the cmdlets created at build-time in the `../exports` folder. | ||
|
||
## Usage | ||
The easiest way currently to start developing custom cmdlets is to copy an existing cmdlet. For C# cmdlets, copy one from the `generated/cmdlets` folder. For script cmdlets, build the project using `build-module.ps1` and copy one of the scripts from the `../exports` folder. After that, if you want to add new parameter sets, follow the guidelines in the `Details` section above. For implementing a new cmdlets, at minimum, please keep these parameters: | ||
- Break | ||
- DefaultProfile | ||
- HttpPipelineAppend | ||
- HttpPipelinePrepend | ||
- Proxy | ||
- ProxyCredential | ||
- ProxyUseDefaultCredentials | ||
|
||
These provide functionality to our HTTP pipeline and other useful features. In script, you can forward these parameters using `$PSBoundParameters` to the other cmdlets you're calling within `Az.HealthDataAIServices`. For C#, follow the usage seen in the `ProcessRecordAsync` method. | ||
|
||
### Attributes | ||
For processing the cmdlets, we've created some additional attributes: | ||
- `Microsoft.Azure.PowerShell.Cmdlets.HealthDataAIServices.DescriptionAttribute` | ||
- Used in C# cmdlets to provide a high-level description of the cmdlet. This is propagated to reference documentation via [help comments](https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comment_based_help) in the exported scripts. | ||
- `Microsoft.Azure.PowerShell.Cmdlets.HealthDataAIServices.DoNotExportAttribute` | ||
- Used in C# and script cmdlets to suppress creating an exported cmdlet at build-time. These cmdlets will *not be exposed* by `Az.HealthDataAIServices`. | ||
- `Microsoft.Azure.PowerShell.Cmdlets.HealthDataAIServices.InternalExportAttribute` | ||
- Used in C# cmdlets to route exported cmdlets to the `../internal`, which are *not exposed* by `Az.HealthDataAIServices`. For more information, see [README.md](../internal/README.md) in the `../internal` folder. | ||
- `Microsoft.Azure.PowerShell.Cmdlets.HealthDataAIServices.ProfileAttribute` | ||
- Used in C# and script cmdlets to define which Azure profiles the cmdlet supports. This is only supported for Azure (`--azure`) modules. |
25 changes: 25 additions & 0 deletions
25
...lthDataAIServices/HealthDataAIServices.Autorest/docs/Az.HealthDataAiServices.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,25 @@ | ||
--- | ||
Module Name: Az.HealthDataAIServices | ||
Module Guid: 8bb9685c-14b3-42f7-8d1d-26a6fe1d48a0 | ||
Download Help Link: https://learn.microsoft.com/powershell/module/az.healthdataaiservices | ||
Help Version: 1.0.0.0 | ||
Locale: en-US | ||
--- | ||
|
||
# Az.HealthDataAIServices Module | ||
## Description | ||
Microsoft Azure PowerShell: HealthDataAiServices cmdlets | ||
|
||
## Az.HealthDataAIServices Cmdlets | ||
### [Get-AzDeidService](Get-AzDeidService.md) | ||
Get a DeidService | ||
|
||
### [New-AzDeidService](New-AzDeidService.md) | ||
create a DeidService | ||
|
||
### [Remove-AzDeidService](Remove-AzDeidService.md) | ||
Delete a DeidService | ||
|
||
### [Update-AzDeidService](Update-AzDeidService.md) | ||
update a DeidService | ||
|
Oops, something went wrong.