@azure/arm-msi 2.1.0-beta.2 → 2.1.0

package/review/arm-msi.api.md

@@ -8,23 +8,6 @@ import * as coreAuth from '@azure/core-auth';
 import * as coreClient from '@azure/core-client';
 import { PagedAsyncIterableIterator } from '@azure/core-paging';
 
-// @public
-export interface AssociatedResourcesListResult {
-    readonly nextLink?: string;
-    readonly totalCount?: number;
-    readonly value?: AzureResource[];
-}
-
-// @public
-export interface AzureResource {
-    readonly id?: string;
-    readonly name?: string;
-    readonly resourceGroup?: string;
-    readonly subscriptionDisplayName?: string;
-    readonly subscriptionId?: string;
-    readonly type?: string;
-}
-
 // @public
 export interface CloudError {
     error?: CloudErrorBody;
@@ -38,6 +21,9 @@ export interface CloudErrorBody {
     target?: string;
 }
 
+// @public
+export type CreatedByType = string;
+
 // @public
 export interface FederatedIdentityCredential extends ProxyResource {
     audiences?: string[];
@@ -73,8 +59,6 @@ export type FederatedIdentityCredentialsGetResponse = FederatedIdentityCredentia
 
 // @public
 export interface FederatedIdentityCredentialsListNextOptionalParams extends coreClient.OperationOptions {
-    skiptoken?: string;
-    top?: number;
 }
 
 // @public
@@ -95,6 +79,9 @@ export interface FederatedIdentityCredentialsListResult {
     value?: FederatedIdentityCredential[];
 }
 
+// @public
+export function getContinuationToken(page: unknown): string | undefined;
+
 // @public
 export interface Identity extends TrackedResource {
     readonly clientId?: string;
@@ -113,6 +100,14 @@ export interface IdentityUpdate extends Resource {
     readonly tenantId?: string;
 }
 
+// @public
+export enum KnownCreatedByType {
+    Application = "Application",
+    Key = "Key",
+    ManagedIdentity = "ManagedIdentity",
+    User = "User"
+}
+
 // @public (undocumented)
 export class ManagedServiceIdentityClient extends coreClient.ServiceClient {
     // (undocumented)
@@ -186,6 +181,7 @@ export interface ProxyResource extends Resource {
 export interface Resource {
     readonly id?: string;
     readonly name?: string;
+    readonly systemData?: SystemData;
     readonly type?: string;
 }
 
@@ -213,6 +209,16 @@ export interface SystemAssignedIdentity extends ProxyResource {
     readonly tenantId?: string;
 }
 
+// @public
+export interface SystemData {
+    createdAt?: Date;
+    createdBy?: string;
+    createdByType?: CreatedByType;
+    lastModifiedAt?: Date;
+    lastModifiedBy?: string;
+    lastModifiedByType?: CreatedByType;
+}
+
 // @public
 export interface TrackedResource extends Resource {
     location: string;
@@ -226,7 +232,6 @@ export interface UserAssignedIdentities {
     createOrUpdate(resourceGroupName: string, resourceName: string, parameters: Identity, options?: UserAssignedIdentitiesCreateOrUpdateOptionalParams): Promise<UserAssignedIdentitiesCreateOrUpdateResponse>;
     delete(resourceGroupName: string, resourceName: string, options?: UserAssignedIdentitiesDeleteOptionalParams): Promise<void>;
     get(resourceGroupName: string, resourceName: string, options?: UserAssignedIdentitiesGetOptionalParams): Promise<UserAssignedIdentitiesGetResponse>;
-    listAssociatedResources(resourceGroupName: string, resourceName: string, options?: UserAssignedIdentitiesListAssociatedResourcesOptionalParams): PagedAsyncIterableIterator<AzureResource>;
     listByResourceGroup(resourceGroupName: string, options?: UserAssignedIdentitiesListByResourceGroupOptionalParams): PagedAsyncIterableIterator<Identity>;
     listBySubscription(options?: UserAssignedIdentitiesListBySubscriptionOptionalParams): PagedAsyncIterableIterator<Identity>;
     update(resourceGroupName: string, resourceName: string, parameters: IdentityUpdate, options?: UserAssignedIdentitiesUpdateOptionalParams): Promise<UserAssignedIdentitiesUpdateResponse>;
@@ -250,30 +255,6 @@ export interface UserAssignedIdentitiesGetOptionalParams extends coreClient.Oper
 // @public
 export type UserAssignedIdentitiesGetResponse = Identity;
 
-// @public
-export interface UserAssignedIdentitiesListAssociatedResourcesNextOptionalParams extends coreClient.OperationOptions {
-    filter?: string;
-    orderby?: string;
-    skip?: number;
-    skiptoken?: string;
-    top?: number;
-}
-
-// @public
-export type UserAssignedIdentitiesListAssociatedResourcesNextResponse = AssociatedResourcesListResult;
-
-// @public
-export interface UserAssignedIdentitiesListAssociatedResourcesOptionalParams extends coreClient.OperationOptions {
-    filter?: string;
-    orderby?: string;
-    skip?: number;
-    skiptoken?: string;
-    top?: number;
-}
-
-// @public
-export type UserAssignedIdentitiesListAssociatedResourcesResponse = AssociatedResourcesListResult;
-
 // @public
 export interface UserAssignedIdentitiesListByResourceGroupNextOptionalParams extends coreClient.OperationOptions {
 }

package/src/index.ts

@@ -7,6 +7,7 @@
  */
 
 /// <reference lib="esnext.asynciterable" />
+export { getContinuationToken } from "./pagingHelper";
 export * from "./models";
 export { ManagedServiceIdentityClient } from "./managedServiceIdentityClient";
 export * from "./operationsInterfaces";

package/src/managedServiceIdentityClient.ts

@@ -60,7 +60,7 @@ export class ManagedServiceIdentityClient extends coreClient.ServiceClient {
       credential: credentials
     };
 
-    const packageDetails = `azsdk-js-arm-msi/2.1.0-beta.2`;
+    const packageDetails = `azsdk-js-arm-msi/2.1.0`;
     const userAgentPrefix =
       options.userAgentOptions && options.userAgentOptions.userAgentPrefix
         ? `${options.userAgentOptions.userAgentPrefix} ${packageDetails}`
@@ -72,39 +72,48 @@ export class ManagedServiceIdentityClient extends coreClient.ServiceClient {
       userAgentOptions: {
         userAgentPrefix
       },
-      baseUri:
+      endpoint:
         options.endpoint ?? options.baseUri ?? "https://management.azure.com"
     };
     super(optionsWithDefaults);
 
+    let bearerTokenAuthenticationPolicyFound: boolean = false;
     if (options?.pipeline && options.pipeline.getOrderedPolicies().length > 0) {
       const pipelinePolicies: coreRestPipeline.PipelinePolicy[] = options.pipeline.getOrderedPolicies();
-      const bearerTokenAuthenticationPolicyFound = pipelinePolicies.some(
+      bearerTokenAuthenticationPolicyFound = pipelinePolicies.some(
         (pipelinePolicy) =>
           pipelinePolicy.name ===
           coreRestPipeline.bearerTokenAuthenticationPolicyName
       );
-      if (!bearerTokenAuthenticationPolicyFound) {
-        this.pipeline.removePolicy({
-          name: coreRestPipeline.bearerTokenAuthenticationPolicyName
-        });
-        this.pipeline.addPolicy(
-          coreRestPipeline.bearerTokenAuthenticationPolicy({
-            scopes: `${optionsWithDefaults.baseUri}/.default`,
-            challengeCallbacks: {
-              authorizeRequestOnChallenge:
-                coreClient.authorizeRequestOnClaimChallenge
-            }
-          })
-        );
-      }
+    }
+    if (
+      !options ||
+      !options.pipeline ||
+      options.pipeline.getOrderedPolicies().length == 0 ||
+      !bearerTokenAuthenticationPolicyFound
+    ) {
+      this.pipeline.removePolicy({
+        name: coreRestPipeline.bearerTokenAuthenticationPolicyName
+      });
+      this.pipeline.addPolicy(
+        coreRestPipeline.bearerTokenAuthenticationPolicy({
+          credential: credentials,
+          scopes:
+            optionsWithDefaults.credentialScopes ??
+            `${optionsWithDefaults.endpoint}/.default`,
+          challengeCallbacks: {
+            authorizeRequestOnChallenge:
+              coreClient.authorizeRequestOnClaimChallenge
+          }
+        })
+      );
     }
     // Parameter assignments
     this.subscriptionId = subscriptionId;
 
     // Assigning values to Constant parameters
     this.$host = options.$host || "https://management.azure.com";
-    this.apiVersion = options.apiVersion || "2022-01-31-preview";
+    this.apiVersion = options.apiVersion || "2023-01-31";
     this.systemAssignedIdentities = new SystemAssignedIdentitiesImpl(this);
     this.operations = new OperationsImpl(this);
     this.userAssignedIdentities = new UserAssignedIdentitiesImpl(this);

package/src/models/index.ts

@@ -11,7 +11,7 @@ import * as coreClient from "@azure/core-client";
 /** Common fields that are returned in the response for all Azure Resource Manager resources */
 export interface Resource {
   /**
-   * Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
+   * Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    * NOTE: This property will not be serialized. It can only be populated by the server.
    */
   readonly id?: string;
@@ -25,6 +25,27 @@ export interface Resource {
    * NOTE: This property will not be serialized. It can only be populated by the server.
    */
   readonly type?: string;
+  /**
+   * Azure Resource Manager metadata containing createdBy and modifiedBy information.
+   * NOTE: This property will not be serialized. It can only be populated by the server.
+   */
+  readonly systemData?: SystemData;
+}
+
+/** Metadata pertaining to creation and last modification of the resource. */
+export interface SystemData {
+  /** The identity that created the resource. */
+  createdBy?: string;
+  /** The type of identity that created the resource. */
+  createdByType?: CreatedByType;
+  /** The timestamp of resource creation (UTC). */
+  createdAt?: Date;
+  /** The identity that last modified the resource. */
+  lastModifiedBy?: string;
+  /** The type of identity that last modified the resource. */
+  lastModifiedByType?: CreatedByType;
+  /** The timestamp of resource last modification (UTC) */
+  lastModifiedAt?: Date;
 }
 
 /** An error response from the ManagedServiceIdentity service. */
@@ -81,59 +102,6 @@ export interface UserAssignedIdentitiesListResult {
   nextLink?: string;
 }
 
-/** Azure resources returned by the resource action to get a list of assigned resources. */
-export interface AssociatedResourcesListResult {
-  /**
-   * Total number of Azure resources assigned to the identity.
-   * NOTE: This property will not be serialized. It can only be populated by the server.
-   */
-  readonly totalCount?: number;
-  /**
-   * The collection of Azure resources returned by the resource action to get a list of assigned resources.
-   * NOTE: This property will not be serialized. It can only be populated by the server.
-   */
-  readonly value?: AzureResource[];
-  /**
-   * The url to get the next page of results, if any.
-   * NOTE: This property will not be serialized. It can only be populated by the server.
-   */
-  readonly nextLink?: string;
-}
-
-/** Describes an Azure resource that is attached to an identity. */
-export interface AzureResource {
-  /**
-   * The ID of this resource.
-   * NOTE: This property will not be serialized. It can only be populated by the server.
-   */
-  readonly id?: string;
-  /**
-   * The name of this resource.
-   * NOTE: This property will not be serialized. It can only be populated by the server.
-   */
-  readonly name?: string;
-  /**
-   * The type of this resource.
-   * NOTE: This property will not be serialized. It can only be populated by the server.
-   */
-  readonly type?: string;
-  /**
-   * The name of the resource group this resource belongs to.
-   * NOTE: This property will not be serialized. It can only be populated by the server.
-   */
-  readonly resourceGroup?: string;
-  /**
-   * The ID of the subscription this resource belongs to.
-   * NOTE: This property will not be serialized. It can only be populated by the server.
-   */
-  readonly subscriptionId?: string;
-  /**
-   * The name of the subscription this resource belongs to.
-   * NOTE: This property will not be serialized. It can only be populated by the server.
-   */
-  readonly subscriptionDisplayName?: string;
-}
-
 /** Values returned by the List operation for federated identity credentials. */
 export interface FederatedIdentityCredentialsListResult {
   /** The collection of federated identity credentials returned by the listing operation. */
@@ -233,6 +201,30 @@ export interface Identity extends TrackedResource {
   readonly clientId?: string;
 }
 
+/** Known values of {@link CreatedByType} that the service accepts. */
+export enum KnownCreatedByType {
+  /** User */
+  User = "User",
+  /** Application */
+  Application = "Application",
+  /** ManagedIdentity */
+  ManagedIdentity = "ManagedIdentity",
+  /** Key */
+  Key = "Key"
+}
+
+/**
+ * Defines values for CreatedByType. \
+ * {@link KnownCreatedByType} can be used interchangeably with CreatedByType,
+ *  this enum contains the known values that the service supports.
+ * ### Known values supported by the service
+ * **User** \
+ * **Application** \
+ * **ManagedIdentity** \
+ * **Key**
+ */
+export type CreatedByType = string;
+
 /** Optional parameters. */
 export interface SystemAssignedIdentitiesGetByScopeOptionalParams
   extends coreClient.OperationOptions {}
@@ -268,24 +260,6 @@ export interface UserAssignedIdentitiesListByResourceGroupOptionalParams
 /** Contains response data for the listByResourceGroup operation. */
 export type UserAssignedIdentitiesListByResourceGroupResponse = UserAssignedIdentitiesListResult;
 
-/** Optional parameters. */
-export interface UserAssignedIdentitiesListAssociatedResourcesOptionalParams
-  extends coreClient.OperationOptions {
-  /** OData filter expression to apply to the query. */
-  filter?: string;
-  /** OData orderBy expression to apply to the query. */
-  orderby?: string;
-  /** Number of records to return. */
-  top?: number;
-  /** Number of records to skip. */
-  skip?: number;
-  /** A skip token is used to continue retrieving items after an operation returns a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skipToken parameter that specifies a starting point to use for subsequent calls. */
-  skiptoken?: string;
-}
-
-/** Contains response data for the listAssociatedResources operation. */
-export type UserAssignedIdentitiesListAssociatedResourcesResponse = AssociatedResourcesListResult;
-
 /** Optional parameters. */
 export interface UserAssignedIdentitiesCreateOrUpdateOptionalParams
   extends coreClient.OperationOptions {}
@@ -325,24 +299,6 @@ export interface UserAssignedIdentitiesListByResourceGroupNextOptionalParams
 /** Contains response data for the listByResourceGroupNext operation. */
 export type UserAssignedIdentitiesListByResourceGroupNextResponse = UserAssignedIdentitiesListResult;
 
-/** Optional parameters. */
-export interface UserAssignedIdentitiesListAssociatedResourcesNextOptionalParams
-  extends coreClient.OperationOptions {
-  /** OData filter expression to apply to the query. */
-  filter?: string;
-  /** OData orderBy expression to apply to the query. */
-  orderby?: string;
-  /** Number of records to return. */
-  top?: number;
-  /** Number of records to skip. */
-  skip?: number;
-  /** A skip token is used to continue retrieving items after an operation returns a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skipToken parameter that specifies a starting point to use for subsequent calls. */
-  skiptoken?: string;
-}
-
-/** Contains response data for the listAssociatedResourcesNext operation. */
-export type UserAssignedIdentitiesListAssociatedResourcesNextResponse = AssociatedResourcesListResult;
-
 /** Optional parameters. */
 export interface FederatedIdentityCredentialsListOptionalParams
   extends coreClient.OperationOptions {
@@ -375,12 +331,7 @@ export interface FederatedIdentityCredentialsDeleteOptionalParams
 
 /** Optional parameters. */
 export interface FederatedIdentityCredentialsListNextOptionalParams
-  extends coreClient.OperationOptions {
-  /** Number of records to return. */
-  top?: number;
-  /** A skip token is used to continue retrieving items after an operation returns a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skipToken parameter that specifies a starting point to use for subsequent calls. */
-  skiptoken?: string;
-}
+  extends coreClient.OperationOptions {}
 
 /** Contains response data for the listNext operation. */
 export type FederatedIdentityCredentialsListNextResponse = FederatedIdentityCredentialsListResult;

package/src/models/mappers.ts

@@ -33,6 +33,58 @@ export const Resource: coreClient.CompositeMapper = {
         type: {
           name: "String"
         }
+      },
+      systemData: {
+        serializedName: "systemData",
+        type: {
+          name: "Composite",
+          className: "SystemData"
+        }
+      }
+    }
+  }
+};
+
+export const SystemData: coreClient.CompositeMapper = {
+  type: {
+    name: "Composite",
+    className: "SystemData",
+    modelProperties: {
+      createdBy: {
+        serializedName: "createdBy",
+        type: {
+          name: "String"
+        }
+      },
+      createdByType: {
+        serializedName: "createdByType",
+        type: {
+          name: "String"
+        }
+      },
+      createdAt: {
+        serializedName: "createdAt",
+        type: {
+          name: "DateTime"
+        }
+      },
+      lastModifiedBy: {
+        serializedName: "lastModifiedBy",
+        type: {
+          name: "String"
+        }
+      },
+      lastModifiedByType: {
+        serializedName: "lastModifiedByType",
+        type: {
+          name: "String"
+        }
+      },
+      lastModifiedAt: {
+        serializedName: "lastModifiedAt",
+        type: {
+          name: "DateTime"
+        }
       }
     }
   }
@@ -202,93 +254,6 @@ export const UserAssignedIdentitiesListResult: coreClient.CompositeMapper = {
   }
 };
 
-export const AssociatedResourcesListResult: coreClient.CompositeMapper = {
-  type: {
-    name: "Composite",
-    className: "AssociatedResourcesListResult",
-    modelProperties: {
-      totalCount: {
-        serializedName: "totalCount",
-        readOnly: true,
-        type: {
-          name: "Number"
-        }
-      },
-      value: {
-        serializedName: "value",
-        readOnly: true,
-        type: {
-          name: "Sequence",
-          element: {
-            type: {
-              name: "Composite",
-              className: "AzureResource"
-            }
-          }
-        }
-      },
-      nextLink: {
-        serializedName: "nextLink",
-        readOnly: true,
-        type: {
-          name: "String"
-        }
-      }
-    }
-  }
-};
-
-export const AzureResource: coreClient.CompositeMapper = {
-  type: {
-    name: "Composite",
-    className: "AzureResource",
-    modelProperties: {
-      id: {
-        serializedName: "id",
-        readOnly: true,
-        type: {
-          name: "String"
-        }
-      },
-      name: {
-        serializedName: "name",
-        readOnly: true,
-        type: {
-          name: "String"
-        }
-      },
-      type: {
-        serializedName: "type",
-        readOnly: true,
-        type: {
-          name: "String"
-        }
-      },
-      resourceGroup: {
-        serializedName: "resourceGroup",
-        readOnly: true,
-        type: {
-          name: "String"
-        }
-      },
-      subscriptionId: {
-        serializedName: "subscriptionId",
-        readOnly: true,
-        type: {
-          name: "String"
-        }
-      },
-      subscriptionDisplayName: {
-        serializedName: "subscriptionDisplayName",
-        readOnly: true,
-        type: {
-          name: "String"
-        }
-      }
-    }
-  }
-};
-
 export const FederatedIdentityCredentialsListResult: coreClient.CompositeMapper = {
   type: {
     name: "Composite",

package/src/models/parameters.ts

@@ -56,7 +56,7 @@ export const scope: OperationURLParameter = {
 export const apiVersion: OperationQueryParameter = {
   parameterPath: "apiVersion",
   mapper: {
-    defaultValue: "2022-01-31-preview",
+    defaultValue: "2023-01-31",
     isConstant: true,
     serializedName: "api-version",
     type: {
@@ -99,57 +99,61 @@ export const resourceGroupName: OperationURLParameter = {
   }
 };
 
-export const resourceName: OperationURLParameter = {
-  parameterPath: "resourceName",
+export const contentType: OperationParameter = {
+  parameterPath: ["options", "contentType"],
   mapper: {
-    serializedName: "resourceName",
-    required: true,
+    defaultValue: "application/json",
+    isConstant: true,
+    serializedName: "Content-Type",
     type: {
       name: "String"
     }
   }
 };
 
-export const filter: OperationQueryParameter = {
-  parameterPath: ["options", "filter"],
-  mapper: {
-    serializedName: "$filter",
-    type: {
-      name: "String"
-    }
-  }
+export const parameters: OperationParameter = {
+  parameterPath: "parameters",
+  mapper: IdentityMapper
 };
 
-export const orderby: OperationQueryParameter = {
-  parameterPath: ["options", "orderby"],
+export const resourceName: OperationURLParameter = {
+  parameterPath: "resourceName",
   mapper: {
-    serializedName: "$orderby",
+    serializedName: "resourceName",
+    required: true,
     type: {
       name: "String"
     }
   }
 };
 
-export const top: OperationQueryParameter = {
-  parameterPath: ["options", "top"],
+export const parameters1: OperationParameter = {
+  parameterPath: "parameters",
+  mapper: IdentityUpdateMapper
+};
+
+export const resourceGroupName1: OperationURLParameter = {
+  parameterPath: "resourceGroupName",
   mapper: {
     constraints: {
-      InclusiveMinimum: 1
+      MaxLength: 90,
+      MinLength: 1
     },
-    serializedName: "$top",
+    serializedName: "resourceGroupName",
+    required: true,
     type: {
-      name: "Number"
+      name: "String"
     }
   }
 };
 
-export const skip: OperationQueryParameter = {
-  parameterPath: ["options", "skip"],
+export const top: OperationQueryParameter = {
+  parameterPath: ["options", "top"],
   mapper: {
     constraints: {
       InclusiveMinimum: 1
     },
-    serializedName: "$skip",
+    serializedName: "$top",
     type: {
       name: "Number"
     }
@@ -166,28 +170,6 @@ export const skiptoken: OperationQueryParameter = {
   }
 };
 
-export const contentType: OperationParameter = {
-  parameterPath: ["options", "contentType"],
-  mapper: {
-    defaultValue: "application/json",
-    isConstant: true,
-    serializedName: "Content-Type",
-    type: {
-      name: "String"
-    }
-  }
-};
-
-export const parameters: OperationParameter = {
-  parameterPath: "parameters",
-  mapper: IdentityMapper
-};
-
-export const parameters1: OperationParameter = {
-  parameterPath: "parameters",
-  mapper: IdentityUpdateMapper
-};
-
 export const parameters2: OperationParameter = {
   parameterPath: "parameters",
   mapper: FederatedIdentityCredentialMapper
@@ -196,6 +178,9 @@ export const parameters2: OperationParameter = {
 export const federatedIdentityCredentialResourceName: OperationURLParameter = {
   parameterPath: "federatedIdentityCredentialResourceName",
   mapper: {
+    constraints: {
+      Pattern: new RegExp("^[a-zA-Z0-9]{1}[a-zA-Z0-9-_]{2,119}$")
+    },
     serializedName: "federatedIdentityCredentialResourceName",
     required: true,
     type: {