Skip to content

Files

Latest commit

0d870b6 · Jan 2, 2025

History

History

ContainerRegistry.Autorest

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
Oct 11, 2023
Jul 20, 2023
Jul 20, 2023
Jul 20, 2023
Dec 5, 2023
Jul 14, 2023
Jul 14, 2023
Jul 14, 2023
Jul 20, 2023
Jan 2, 2025
Jul 14, 2023
Jul 14, 2023

README.md

Az.ContainerRegistry

This directory contains the PowerShell module for the ContainerRegistry service.


Status

Az.ContainerRegistry

Info

  • Modifiable: yes
  • Generated: all
  • Committed: yes
  • Packaged: yes

Detail

This module was primarily generated via AutoRest using the PowerShell extension.

Module Requirements

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.ContainerRegistry, see how-to.md.


Generation Requirements

Use of the beta version of autorest.powershell generator requires the following:

  • NodeJS LTS (10.15.x LTS preferred)
    • Note: It will not work with Node < 10.x. Using 11.x builds may cause issues as they may introduce instability or breaking changes.

If you want an easy way to install and update Node, NVS - Node Version Switcher or NVM - Node Version Manager is recommended.

  • AutoRest v3 beta
    npm install -g autorest@autorest
     
  • PowerShell 6.0 or greater
    • If you don't have it installed, you can use the cross-platform npm package
      npm install -g pwsh
       
  • .NET Core SDK 2.0 or greater
    • If you don't have it installed, you can use the cross-platform npm package
      npm install -g dotnet-sdk-2.2
       

Run Generation

In this directory, run AutoRest:

autorest-beta


AutoRest Configuration

see https://aka.ms/autorest

commit: 66174681c09b101de03fd35399080cfbccc93e8f
require:
  - $(this-folder)/../../readme.azure.noprofile.md
  - $(repo)/specification/containerregistry/resource-manager/readme.md
try-require:
  - $(repo)/specification/containerregistry/resource-manager/readme.powershell.md
module-version: 0.1.0
title: ContainerRegistry
subject-prefix: $(service-name)

inlining-threshold: 100
resourcegroup-append: true
nested-object-to-string: true

# For new modules, please avoid setting 3.x using the use-extension method and instead, use 4.x as the default option
use-extension:
  "@autorest/powershell": "3.x"

directive:
# Remove cmdlet, Private link related resource should be ignored. 
- where:
    subject: RegistryPrivateLinkResource
  hide: true
# Remove the unexpanded parameter set
- where:
    variant: ^Create$|^CreateViaIdentityExpanded$|^Update$|^UpdateViaIdentity$|^CreateViaIdentity$|^ImportViaIdentity$|^ImportViaIdentityExpanded$|^CheckViaIdentity$|^CheckViaIdentityExpanded$|^PingViaIdentity$|^Check$|^RegenerateViaIdentity$|^Generate$|^GenerateViaIdentity$
  remove: true
- where:
    subject: PrivateEndpointConnection
  hide: true
- where:
    subject: (.*)ConnectedRegistry
  hide: true
- where:
    verb: New
    subject: RegistryCredentials
  hide: true
- where:
    subject: (.*)(Run)
  hide: true
- where:
    verb: update
    subject: Replication 
  hide: true
- where:
    subject: CacheRule
  hide: true
- where:
    subject: (.*)CredentialSet
  hide: true
- where:
    subject: (.*)Task(.*)
  hide: true
- where:
    subject: (.*)UploadUrl
  hide: true
- where:
    verb: Ping
  set: 
    verb: Test
- where:
    verb: New
    subject: RegistryCredential
  set:
    verb: Update
- model-cmdlet:
    - IPRule
- where:
    verb: Get
    subject: RegistryCredentials
  set:
    subject: RegistryCredential
- where:
    parameter-name: AdminUserEnabled
  set:
    parameter-name: EnableAdminUser
- where:
    parameter-name: SkuName
  set:
    parameter-name: Sku

    
- where:
    parameter-name: ServiceUri
  set:
    alias: Uri
- where:
    parameter-name: Tag
  set:
    alias: Tags
- where:
    parameter-name: CustomHeader
  set:
    alias: Header
- where:
    verb: Get
    subject: RegistryCredential|RegistryUsage
    parameter-name: RegistryName
  set:
    alias: Name
- where:
    verb: Get
    subject: Replication
    parameter-name: Name
  set:
    alias: 
    - ResourceName
    - ReplicationName
- where:
    subject: Replication|Webhook|WebhookEvent
    parameter-name: RegistryName
  set:
    alias: ContainerRegistryName
- where:
    subject: Webhook
    parameter-name: Name
  set:
    alias: 
    - WebhookName
    - ResourceName
- where:
    subject: Registry
    parameter-name: Name
  set:
    alias: 
    - RegistryName
    - ResourceName
    - ContainerRegistryName
- where:
    subject: Replication
    parameter-name: Location
  set:
    alias: ReplicationLocation
- where:
    subject: Replication
    parameter-name: Name
  set:
    alias: 
    - ReplicationName
    - ResourceName
- where:
    verb: Update
    subject: RegistryCredential
    parameter-name: Name
  set:
    parameter-name: PasswordName
- where:
    verb: Update
    subject: RegistryCredential
    parameter-name: RegistryName
  set:
    alias: 
    - ContainerRegistryName
    - Name
    - ResourceName
- where:
    verb: Import
    subject: RegistryImage
    parameter-name: CredentialsPassword
  set:
    parameter-name: Password
- where:
    verb: Import
    subject: RegistryImage
    parameter-name: CredentialsUsername
  set:
    parameter-name: Username
- where:
    verb: Import
    subject: RegistryImage
    parameter-name: SourceResourceId
  set:
    alias: SourceRegistryResourceId

#Format
- where:
    model-name: Webhook
  set:
    format-table: 
      properties:
        - Name
        - Location
        - Status
        - Scope
        - Actions
        - ProvisioningState
- where:
    model-name: Event
  set:
    format-table: 
      properties:
        - ID
        - ContentAction
        - ContentTimestamp
        - ResponseMessageStatusCode
- where:
    model-name: ScopeMap
  set:
    format-table: 
      properties:
        - Name
        - Action
        - Type
- where:
    model-name: Registry
  set:
    format-table: 
      properties:
        - Name
        - SkuName
        - LoginServer
        - CreationDate
        - ProvisioningState
        - AdminUserEnabled
- where:
    model-name: Replication
  set:
    format-table: 
      properties:
        - Name
        - Location
        - ProvisioningState
        - Status
        - StatusTimestamp
- where:
    model-name: AgentPool
  set:
    format-table: 
      properties:
        - Name
        - Location
        - OS
        - Count
        - ProvisioningState
- where:
    model-name: Token 
  set:
    format-table: 
      properties:
        - Name
        - Status
        - ProvisioningState
        - Type
        - ResourceGroupName

# custom hide
- where:
    verb: Get
    subject: RegistryCredential|Replication
  hide: true
- where:
    verb: Get
    subject: (.*)WebhookEvent
  hide: true
- where:
    verb: Get
    subject: Webhook
  hide: true
- where:
    verb: New
    subject: Replication|Webhook
  hide: true
- where:
    verb: Test
    subject: Webhook
  hide: true  
- where:
    verb: Update
    subject: RegistryCredential
  hide: true
- where:
    verb: Get
    subject: Registry
  hide: true
# preview cmdlet
- where:
    subject: (.*)AgentPool(.*)|(.*)Pipeline|(.*)ScopeMap|(.*)Token|(.*)WebhookCallbackConfig
  set:
    preview-announcement:
      preview-message: This is a preview version of ContainerRegistry. Let us know if you run into any issues.