Update resource properties with consistent client provided key as Graph metadata (#64)

Author: jason-dou

generated/microsoftgraph/microsoft.graph/beta/types.json

@@ -23,7 +23,6 @@
 * **isFallbackPublicClient**: bool
 * **keyCredentials**: [MicrosoftGraphKeyCredential](#microsoftgraphkeycredential)[]
 * **logo**: string
-* **name**: string (Required, DeployTimeConstant): The resource name
 * **notes**: string
 * **optionalClaims**: [MicrosoftGraphOptionalClaims](#microsoftgraphoptionalclaims)
 * **parentalControlSettings**: [MicrosoftGraphParentalControlSettings](#microsoftgraphparentalcontrolsettings)
@@ -40,6 +39,7 @@
 * **tags**: string[]
 * **tokenEncryptionKeyId**: string {minLength: 36, maxLength: 36, pattern: "^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$"}
 * **type**: 'Microsoft.Graph/applications' (ReadOnly, DeployTimeConstant): The resource type
+* **uniqueName**: string (Required, DeployTimeConstant)
 * **verifiedPublisher**: [MicrosoftGraphVerifiedPublisher](#microsoftgraphverifiedpublisher)
 * **web**: [MicrosoftGraphWebApplication](#microsoftgraphwebapplication)
 * **windows**: [MicrosoftGraphWindowsApplication](#microsoftgraphwindowsapplication)
@@ -51,7 +51,6 @@
 * **appRoleId**: string {minLength: 36, maxLength: 36, pattern: "^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$"} (Required)
 * **creationTimestamp**: string (ReadOnly)
 * **id**: string (ReadOnly, DeployTimeConstant): The resource id
-* **name**: string: The resource name
 * **principalDisplayName**: string (ReadOnly)
 * **principalId**: string {minLength: 36, maxLength: 36, pattern: "^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$"} (Required)
 * **principalType**: string (ReadOnly)
@@ -81,7 +80,6 @@
 * **members**: string[]
 * **membershipRule**: string
 * **membershipRuleProcessingState**: string
-* **name**: string (Required, DeployTimeConstant): The resource name
 * **onPremisesDomainName**: string (ReadOnly)
 * **onPremisesLastSyncDateTime**: string (ReadOnly)
 * **onPremisesNetBiosName**: string (ReadOnly)
@@ -102,6 +100,7 @@
 * **serviceProvisioningErrors**: [MicrosoftGraphServiceProvisioningError](#microsoftgraphserviceprovisioningerror)[]
 * **theme**: string
 * **type**: 'Microsoft.Graph/groups' (ReadOnly, DeployTimeConstant): The resource type
+* **uniqueName**: string (Required, DeployTimeConstant)
 * **visibility**: string
 * **writebackConfiguration**: [MicrosoftGraphGroupWritebackConfiguration](#microsoftgraphgroupwritebackconfiguration)
 
@@ -112,7 +111,6 @@
 * **clientId**: string (Required)
 * **consentType**: string (Required)
 * **id**: string (ReadOnly, DeployTimeConstant): The resource id
-* **name**: string: The resource name
 * **principalId**: string
 * **resourceId**: string (Required)
 * **scope**: string
@@ -142,7 +140,6 @@
 * **keyCredentials**: [MicrosoftGraphKeyCredential](#microsoftgraphkeycredential)[]
 * **loginUrl**: string
 * **logoutUrl**: string
-* **name**: string: The resource name
 * **notes**: string
 * **notificationEmailAddresses**: string[]
 * **passwordCredentials**: [MicrosoftGraphPasswordCredential](#microsoftgraphpasswordcredential)[]
@@ -188,6 +185,7 @@
 
 ## MicrosoftGraphAuthenticationBehaviors
 ### Properties
+* **blockAzureADGraphAccess**: bool
 * **removeUnverifiedEmailClaim**: bool
 * **requireClientServicePrincipal**: bool
 

generated/microsoftgraph/microsoft.graph/beta/types.md

@@ -11,11 +11,6 @@ import { failure, success } from "./utils";
 export function generateTypes(host: AutorestExtensionHost, definition: ProviderDefinition) {
   const factory = new TypeFactory();
   const namedDefinitions: Dictionary<TypeReference> = {};
-  const typesWithoutRequiredName: Set<string> = new Set([
-    'Microsoft.Graph/servicePrincipals',
-    'Microsoft.Graph/oauth2PermissionGrants',
-    'Microsoft.Graph/appRoleAssignedTo',
-  ]);
 
   function logWarning(message: string) {
     host.message({ Channel: Channel.Warning, Text: message, });
@@ -241,13 +236,9 @@ export function generateTypes(host: AutorestExtensionHost, definition: ProviderD
   function getStandardizedResourceProperties(descriptor: ResourceDescriptor, resourceName: TypeReference): Dictionary<ObjectTypeProperty> {
     const fullyQualifiedType = getFullyQualifiedType(descriptor);
     const type = factory.addStringLiteralType(fullyQualifiedType);
-    const nameFlag = typesWithoutRequiredName.has(fullyQualifiedType)
-      ? ObjectTypePropertyFlags.None
-      : ObjectTypePropertyFlags.Required | ObjectTypePropertyFlags.DeployTimeConstant;
 
     return {
       id: createObjectTypeProperty(factory.addStringType(), ObjectTypePropertyFlags.ReadOnly | ObjectTypePropertyFlags.DeployTimeConstant, 'The resource id'),
-      name: createObjectTypeProperty(resourceName, nameFlag, 'The resource name'),
       type: createObjectTypeProperty(type, ObjectTypePropertyFlags.ReadOnly | ObjectTypePropertyFlags.DeployTimeConstant, 'The resource type'),
       apiVersion: createObjectTypeProperty(factory.addStringLiteralType(descriptor.apiVersion), ObjectTypePropertyFlags.ReadOnly | ObjectTypePropertyFlags.DeployTimeConstant, 'The resource api version'),
     };
@@ -440,6 +431,10 @@ export function generateTypes(host: AutorestExtensionHost, definition: ProviderD
       flags |= ObjectTypePropertyFlags.WriteOnly;
     }
 
+    if (putProperty && putProperty.extensions?.['x-constant-key']) {
+      flags |= ObjectTypePropertyFlags.DeployTimeConstant;
+    }
+
     return flags;
   }
 

src/autorest.bicep/src/type-generator.ts

@@ -9,7 +9,6 @@
 * **bar**: string: The bar property
 * **foo**: string: The foo property
 * **id**: string (ReadOnly, DeployTimeConstant): The resource id
-* **name**: string (Required, DeployTimeConstant): The resource name
 * **type**: 'Test.Rp1/discriminatedUnionTestType' (ReadOnly, DeployTimeConstant): The resource type
 
 ### DiscriminatedUnionTestTypeBranchWithInheritedProps
@@ -37,7 +36,7 @@
 * **apiVersion**: '2021-10-31' (ReadOnly, DeployTimeConstant): The resource api version
 * **id**: string (ReadOnly, DeployTimeConstant): The resource id
 * **location**: string (Required): The geo-location where the resource lives
-* **name**: string (Required, DeployTimeConstant): The resource name
+* **name**: string (ReadOnly): The name of the resource
 * **properties**: [TestType1Properties](#testtype1properties)
 * **systemData**: [SystemData](#systemdata) (ReadOnly): Azure Resource Manager metadata containing createdBy and modifiedBy information.
 * **tags**: [TrackedResourceTags](#trackedresourcetags): Resource tags.
@@ -49,7 +48,7 @@
 * **apiVersion**: '2021-10-31' (ReadOnly, DeployTimeConstant): The resource api version
 * **id**: string (ReadOnly, DeployTimeConstant): The resource id
 * **location**: string (ReadOnly): The geo-location where the resource lives
-* **name**: string (Required, DeployTimeConstant): The resource name
+* **name**: string (ReadOnly): The name of the resource
 * **properties**: [ReadOnlyTestTypeProperties](#readonlytesttypeproperties) (ReadOnly)
 * **systemData**: [SystemData](#systemdata) (ReadOnly): Azure Resource Manager metadata containing createdBy and modifiedBy information.
 * **tags**: [TrackedResourceTags](#trackedresourcetags) (ReadOnly): Resource tags.
@@ -61,7 +60,7 @@
 * **apiVersion**: '2021-10-31' (ReadOnly, DeployTimeConstant): The resource api version
 * **id**: string (ReadOnly, DeployTimeConstant): The resource id
 * **location**: string (Required): The geo-location where the resource lives
-* **name**: 'constantName' | 'yetAnotherName' | string (Required, DeployTimeConstant): The resource name
+* **name**: string (ReadOnly): The name of the resource
 * **properties**: [TestType1CreateOrUpdatePropertiesOrTestType1Properties](#testtype1createorupdatepropertiesortesttype1properties): The resource properties.
 * **systemData**: [SystemData](#systemdata) (ReadOnly): Azure Resource Manager metadata containing createdBy and modifiedBy information.
 * **tags**: [TrackedResourceTags](#trackedresourcetags): Resource tags.
@@ -73,7 +72,7 @@
 * **apiVersion**: '2021-10-31' (ReadOnly, DeployTimeConstant): The resource api version
 * **id**: string (ReadOnly, DeployTimeConstant): The resource id
 * **location**: string (Required): The geo-location where the resource lives
-* **name**: string (Required, DeployTimeConstant): The resource name
+* **name**: string (ReadOnly): The name of the resource
 * **properties**: [TestType1CreateOrUpdatePropertiesOrTestType1Properties](#testtype1createorupdatepropertiesortesttype1properties): The resource properties.
 * **systemData**: [SystemData](#systemdata) (ReadOnly): Azure Resource Manager metadata containing createdBy and modifiedBy information.
 * **tags**: [TrackedResourceTags](#trackedresourcetags): Resource tags.
@@ -82,7 +81,7 @@
 ## Function listArrayOfFoos (Test.Rp1/testType1@2021-10-31)
 * **Resource**: Test.Rp1/testType1
 * **ApiVersion**: 2021-10-31
-* **Output**: [FoosResponse](#foosresponse)[]
+* **Output**: [FoosResponse](#foosresponse)[] {minLength: 1, maxLength: 10}
 
 ## Function listFoos (Test.Rp1/testType1@2021-10-31)
 * **Resource**: Test.Rp1/testType1
@@ -118,11 +117,11 @@
 * **city**: string: The city or locality where the resource is located.
 * **countryOrRegion**: string: The country or region where the resource is located
 * **district**: string: The district, state, or province where the resource is located.
-* **name**: string (Required): A canonical name for the geographic or physical location.
+* **name**: string {maxLength: 256} (Required): A canonical name for the geographic or physical location.
 
 ## Plan
 ### Properties
-* **name**: string (Required): A user defined name of the 3rd Party Artifact that is being procured.
+* **name**: string (Required, DeployTimeConstant): A user defined name of the 3rd Party Artifact that is being procured.
 * **product**: string (Required): The 3rd Party artifact that is being procured. E.g. NewRelic. Product maps to the OfferID specified for the artifact at the time of Data Market onboarding.
 * **promotionCode**: string: A publisher provided promotion code as provisioned in Data Market for the said product/artifact.
 * **publisher**: string (Required): The publisher of the 3rd Party Artifact that is being bought. E.g. NewRelic
@@ -148,9 +147,12 @@
 * **binaryBuffer**: any (ReadOnly)
 * **encryptionProperties**: [EncryptionProperties](#encryptionproperties): TestType1 encryption properties
 * **locationData**: [LocationData](#locationdata) (ReadOnly): Metadata pertaining to the geographic location of the resource.
+* **password**: string {sensitive, pattern: "^[a-zA-Z0-9\.]$"}
+* **percentageProperty**: int {minValue: 0, maxValue: 100} (ReadOnly)
 * **skuTier**: 'Basic' | 'Free' | 'Premium' | 'Standard': This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT.
 * **stringEnum**: 'Bar' | 'Foo' | string: Description for a basic enum property.
 * **subnetId**: string (ReadOnly): A fully-qualified resource ID
+* **uuidProperty**: string {minLength: 36, maxLength: 36, pattern: "^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$"}
 
 ## TestType1Properties
 ### Properties
@@ -159,9 +161,12 @@
 * **binaryBuffer**: any
 * **encryptionProperties**: [EncryptionProperties](#encryptionproperties): TestType1 encryption properties
 * **locationData**: [LocationData](#locationdata): Metadata pertaining to the geographic location of the resource.
+* **password**: string {sensitive, pattern: "^[a-zA-Z0-9\.]$"}
+* **percentageProperty**: int {minValue: 0, maxValue: 100}
 * **skuTier**: 'Basic' | 'Free' | 'Premium' | 'Standard': This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT.
 * **stringEnum**: 'Bar' | 'Foo' | string: Description for a basic enum property.
 * **subnetId**: string: A fully-qualified resource ID
+* **uuidProperty**: string {minLength: 36, maxLength: 36, pattern: "^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$"}
 
 ## TrackedResourceTags
 ### Properties

src/autorest.bicep/test/integration/generated/basic/test.rp1/2021-10-31/types.json

@@ -92,6 +92,15 @@
         "encryptionProperties": {
           "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/encryptionProperties",
           "description": "TestType1 encryption properties"
+        },
+        "password": {
+          "type": "string",
+          "x-ms-secret": true,
+          "pattern": "^[a-zA-Z0-9\\.]$"
+        },
+        "uuidProperty": {
+          "type": "string",
+          "format": "uuid"
         }
       }
     },
@@ -124,6 +133,11 @@
               }
             ]
           }
+        },
+        "percentageProperty": {
+          "type": "integer",
+          "minimum": 0,
+          "maximum": 100
         }
       }
     },
@@ -170,7 +184,9 @@
       "type": "array",
       "items": {
         "$ref": "#/definitions/FoosResponse"
-      }
+      },
+      "minItems": 1,
+      "maxItems": 10
     },
     "DiscriminatedUnionTestType": {
       "allOf": [

src/autorest.bicep/test/integration/generated/basic/test.rp1/2021-10-31/types.md

@@ -265,7 +265,8 @@
       "properties": {
         "name": {
           "type": "string",
-          "description": "A user defined name of the 3rd Party Artifact that is being procured."
+          "description": "A user defined name of the 3rd Party Artifact that is being procured.",
+          "x-constant-key": true
         },
         "publisher": {
           "type": "string",
@@ -692,4 +693,4 @@
       "x-ms-parameter-location": "method"
     }
   }
-}
+}

src/autorest.bicep/test/integration/specs/basic/resource-manager/Test.Rp1/stable/2021-10-31/spec.json

@@ -53,6 +53,7 @@ EntityTypes:
       - securityIdentifier
       - serviceProvisioningErrors
       - theme
+      - uniqueName
       - visibility
       - writebackConfiguration
     NavigationProperty:
@@ -63,6 +64,7 @@ EntityTypes:
       - mailEnabled
       - mailNickname
       - securityEnabled
+      - uniqueName
     ReadOnly:
       - createdByAppId
       - createdDateTime
@@ -113,11 +115,13 @@ EntityTypes:
       - spa
       - tags
       - tokenEncryptionKeyId
+      - uniqueName
       - verifiedPublisher
       - web
       - windows
     RequiredOnWrite:
       - displayName
+      - uniqueName
     ReadOnly:
       - appId
       - certification

src/autorest.bicep/test/integration/specs/common-types/resource-management/v3/types.json

@@ -154,6 +154,10 @@
         "theme": {
           "type": "string"
         },
+        "uniqueName": {
+          "type": "string",
+          "x-constant-key": true
+        },
         "visibility": {
           "type": "string"
         },
@@ -182,7 +186,8 @@
         "displayName",
         "mailEnabled",
         "mailNickname",
-        "securityEnabled"
+        "securityEnabled",
+        "uniqueName"
       ]
     },
     "microsoft.graph.application": {
@@ -309,6 +314,10 @@
           "type": "string",
           "format": "uuid"
         },
+        "uniqueName": {
+          "type": "string",
+          "x-constant-key": true
+        },
         "verifiedPublisher": {
           "$ref": "#/definitions/microsoft.graph.verifiedPublisher"
         },
@@ -325,7 +334,8 @@
         }
       },
       "required": [
-        "displayName"
+        "displayName",
+        "uniqueName"
       ]
     },
     "microsoft.graph.servicePrincipal": {
@@ -717,6 +727,9 @@
     "microsoft.graph.authenticationBehaviors": {
       "type": "object",
       "properties": {
+        "blockAzureADGraphAccess": {
+          "type": "boolean"
+        },
         "removeUnverifiedEmailClaim": {
           "type": "boolean"
         },

src/swagger-generation/config.yml

@@ -72,6 +72,9 @@ export class EntityType extends Object {
       if (property.ReadOnly)
         swaggerProperty.readOnly = property.ReadOnly
 
+      if (this.AlternateKey && this.Name.toLowerCase() !== "serviceprincipal" && property.Name === this.AlternateKey)
+        swaggerProperty["x-constant-key"] = true
+
       definition.properties[property.Name] = swaggerProperty
     });