Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/ManagedServiceIdentity/Az.ManagedServiceIdentity.psd1
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
@{
GUID = '1f09fbda-2563-4cfc-9098-100c27b52fa1'
RootModule = './Az.ManagedServiceIdentity.psm1'
ModuleVersion = '0.2.0'
ModuleVersion = '0.3.0'
CompatiblePSEditions = 'Core', 'Desktop'
Author = 'Microsoft Corporation'
CompanyName = 'Microsoft Corporation'
Expand Down
29 changes: 25 additions & 4 deletions src/ManagedServiceIdentity/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,13 +34,14 @@ branch: main
require:
- $(this-folder)/../readme.azure.noprofile.md
input-file:
- $(repo)/specification/msi/resource-manager/Microsoft.ManagedIdentity/stable/2023-01-31/ManagedIdentity.json
- $(repo)/specification/msi/resource-manager/Microsoft.ManagedIdentity/preview/2022-01-31-preview/ManagedIdentity.json

subject-prefix: ""
resourcegroup-append: true
nested-object-to-string: true
identity-correction-for-post: true
module-version: 0.2.0
module-version: 0.3.0

directive:
- where:
Expand All @@ -65,7 +66,7 @@ directive:
set:
parameter-name: Name

# Associated Resources
# Associated Resources use 2022-01-31-preview API version

- where:
subject: UserAssignedIdentityAssociatedResource
Expand All @@ -78,6 +79,8 @@ directive:
set:
preview-message: This is a preview version of the Associated Resources feature.

# END

# Federated identity credentials

- where:
Expand Down Expand Up @@ -132,8 +135,26 @@ directive:
- Subject
- Audience

# END

# Below instructions remove duplicate API methods which use 2022-01-31-preview. MUST be removed when 2022-01-31-preview is removed.

- where:
subject: FederatedIdentityCredentials
set:
preview-message: This is a preview version of the Federated Identity Credentials feature.
variant: ^Get1$|^List1$|^GetViaIdentity1$|^Create1$|^CreateExpanded1$|^CreateViaIdentity1$|^CreateViaIdentityExpanded1$|^Delete1$|^DeleteViaIdentity1$|^Update1$|^UpdateExpanded1$|^UpdateViaIdentity1$|^UpdateViaIdentityExpanded1$
remove: true

- where:
verb: Get
subject: SystemAssignedIdentity
variant: ^Get1$|^GetViaIdentity1$
remove: true

- where:
subject: UserAssignedIdentity
variant: ^Get1$|^GetViaIdentity1$|^List2$|^List3$|^Create1$|^CreateExpanded1$|^CreateViaIdentity1$|^CreateViaIdentityExpanded1$|^Delete1$|^DeleteViaIdentity1$|^Update1$|^UpdateExpanded1$|^UpdateViaIdentity1$|^UpdateViaIdentityExpanded1$
remove: true

# END

```
2 changes: 1 addition & 1 deletion src/ManagedServiceIdentity/custom/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ These provide functionality to our HTTP pipeline and other useful features. In s
### Attributes
For processing the cmdlets, we've created some additional attributes:
- `Microsoft.Azure.PowerShell.Cmdlets.ManagedServiceIdentity.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.
- Used in C# cmdlets to provide a high-level description of the cmdlet. This is propagated to reference documentation via [help comments](https://docs.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comment_based_help) in the exported scripts.
- `Microsoft.Azure.PowerShell.Cmdlets.ManagedServiceIdentity.DoNotExportAttribute`
- Used in C# and script cmdlets to suppress creating an exported cmdlet at build-time. These cmdlets will *not be exposed* by `Az.ManagedServiceIdentity`.
- `Microsoft.Azure.PowerShell.Cmdlets.ManagedServiceIdentity.InternalExportAttribute`
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -142,7 +142,8 @@ Accept wildcard characters: False
```

### -ResourceGroupName
The name of the Resource Group to which the identity belongs.
The name of the resource group.
The name is case insensitive.

```yaml
Type: System.String
Expand Down Expand Up @@ -211,7 +212,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable

## OUTPUTS

### Microsoft.Azure.PowerShell.Cmdlets.ManagedServiceIdentity.Models.Api20220131Preview.IFederatedIdentityCredential
### Microsoft.Azure.PowerShell.Cmdlets.ManagedServiceIdentity.Models.Api20230131.IFederatedIdentityCredential

## NOTES

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable

## OUTPUTS

### Microsoft.Azure.PowerShell.Cmdlets.ManagedServiceIdentity.Models.Api20220131Preview.ISystemAssignedIdentity
### Microsoft.Azure.PowerShell.Cmdlets.ManagedServiceIdentity.Models.Api20230131.ISystemAssignedIdentity

## NOTES

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -182,7 +182,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable

## OUTPUTS

### Microsoft.Azure.PowerShell.Cmdlets.ManagedServiceIdentity.Models.Api20220131Preview.IIdentity
### Microsoft.Azure.PowerShell.Cmdlets.ManagedServiceIdentity.Models.Api20230131.IIdentity

## NOTES

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -130,7 +130,8 @@ Accept wildcard characters: False
```

### -ResourceGroupName
The name of the Resource Group to which the identity belongs.
The name of the resource group.
The name is case insensitive.

```yaml
Type: System.String
Expand Down Expand Up @@ -212,7 +213,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable

## OUTPUTS

### Microsoft.Azure.PowerShell.Cmdlets.ManagedServiceIdentity.Models.Api20220131Preview.IFederatedIdentityCredential
### Microsoft.Azure.PowerShell.Cmdlets.ManagedServiceIdentity.Models.Api20230131.IFederatedIdentityCredential

## NOTES

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -166,7 +166,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable

## OUTPUTS

### Microsoft.Azure.PowerShell.Cmdlets.ManagedServiceIdentity.Models.Api20220131Preview.IIdentity
### Microsoft.Azure.PowerShell.Cmdlets.ManagedServiceIdentity.Models.Api20230131.IIdentity

## NOTES

Expand Down
2 changes: 1 addition & 1 deletion src/ManagedServiceIdentity/docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,4 @@ This directory contains the documentation of the cmdlets for the `Az.ManagedServ
- Packaged: yes

## Details
The process of documentation generation loads `Az.ManagedServiceIdentity` and analyzes the exported cmdlets from the module. It recognizes the [help comments](https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comment_based_help) that are generated into the scripts in the `../exports` folder. Additionally, when writing custom cmdlets in the `../custom` folder, you can use the help comments syntax, which decorate the exported scripts at build-time. The documentation examples are taken from the `../examples` folder.
The process of documentation generation loads `Az.ManagedServiceIdentity` and analyzes the exported cmdlets from the module. It recognizes the [help comments](https://docs.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comment_based_help) that are generated into the scripts in the `../exports` folder. Additionally, when writing custom cmdlets in the `../custom` folder, you can use the help comments syntax, which decorate the exported scripts at build-time. The documentation examples are taken from the `../examples` folder.
Original file line number Diff line number Diff line change
Expand Up @@ -122,7 +122,8 @@ Accept wildcard characters: False
```

### -ResourceGroupName
The name of the Resource Group to which the identity belongs.
The name of the resource group.
The name is case insensitive.

```yaml
Type: System.String
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -152,7 +152,8 @@ Accept wildcard characters: False
```

### -ResourceGroupName
The name of the Resource Group to which the identity belongs.
The name of the resource group.
The name is case insensitive.

```yaml
Type: System.String
Expand Down Expand Up @@ -236,7 +237,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable

## OUTPUTS

### Microsoft.Azure.PowerShell.Cmdlets.ManagedServiceIdentity.Models.Api20220131Preview.IFederatedIdentityCredential
### Microsoft.Azure.PowerShell.Cmdlets.ManagedServiceIdentity.Models.Api20230131.IFederatedIdentityCredential

## NOTES

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -204,7 +204,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable

## OUTPUTS

### Microsoft.Azure.PowerShell.Cmdlets.ManagedServiceIdentity.Models.Api20220131Preview.IIdentity
### Microsoft.Azure.PowerShell.Cmdlets.ManagedServiceIdentity.Models.Api20230131.IIdentity

## NOTES

Expand Down
2 changes: 1 addition & 1 deletion src/ManagedServiceIdentity/how-to.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ To generate documentation, the process is now integrated into the `build-module.
To test the cmdlets, we use [Pester](https://github.com/pester/Pester). Tests scripts (`.ps1`) should be added to the `test` folder. To execute the Pester tests, run the `test-module.ps1` script. This will run all tests in `playback` mode within the `test` folder. To read more about testing cmdlets, look at the [README.md](examples/README.md) in the `examples` folder.

## Packing `Az.ManagedServiceIdentity`
To pack `Az.ManagedServiceIdentity` for distribution, run the `pack-module.ps1` script. This will take the contents of multiple directories and certain root-folder files to create a `.nupkg`. The structure of the `.nupkg` is created so it can be loaded part of a [PSRepository](https://learn.microsoft.com/powershell/module/powershellget/register-psrepository). Additionally, this package is in a format for distribution to the [PSGallery](https://www.powershellgallery.com/). For signing an Azure module, please contact the [Azure PowerShell](https://github.com/Azure/azure-powershell) team.
To pack `Az.ManagedServiceIdentity` for distribution, run the `pack-module.ps1` script. This will take the contents of multiple directories and certain root-folder files to create a `.nupkg`. The structure of the `.nupkg` is created so it can be loaded part of a [PSRepository](https://docs.microsoft.com/powershell/module/powershellget/register-psrepository). Additionally, this package is in a format for distribution to the [PSGallery](https://www.powershellgallery.com/). For signing an Azure module, please contact the [Azure PowerShell](https://github.com/Azure/azure-powershell) team.

## Module Script Details
There are multiple scripts created for performing different actions for developing `Az.ManagedServiceIdentity`.
Expand Down
Loading