@azure/arm-msi 2.1.0-beta.1 → 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;
@@ -39,22 +22,91 @@ export interface CloudErrorBody {
 }
 
 // @public
-export type Identity = TrackedResource & {
-    readonly tenantId?: string;
-    readonly principalId?: string;
+export type CreatedByType = string;
+
+// @public
+export interface FederatedIdentityCredential extends ProxyResource {
+    audiences?: string[];
+    issuer?: string;
+    subject?: string;
+}
+
+// @public
+export interface FederatedIdentityCredentials {
+    createOrUpdate(resourceGroupName: string, resourceName: string, federatedIdentityCredentialResourceName: string, parameters: FederatedIdentityCredential, options?: FederatedIdentityCredentialsCreateOrUpdateOptionalParams): Promise<FederatedIdentityCredentialsCreateOrUpdateResponse>;
+    delete(resourceGroupName: string, resourceName: string, federatedIdentityCredentialResourceName: string, options?: FederatedIdentityCredentialsDeleteOptionalParams): Promise<void>;
+    get(resourceGroupName: string, resourceName: string, federatedIdentityCredentialResourceName: string, options?: FederatedIdentityCredentialsGetOptionalParams): Promise<FederatedIdentityCredentialsGetResponse>;
+    list(resourceGroupName: string, resourceName: string, options?: FederatedIdentityCredentialsListOptionalParams): PagedAsyncIterableIterator<FederatedIdentityCredential>;
+}
+
+// @public
+export interface FederatedIdentityCredentialsCreateOrUpdateOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type FederatedIdentityCredentialsCreateOrUpdateResponse = FederatedIdentityCredential;
+
+// @public
+export interface FederatedIdentityCredentialsDeleteOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export interface FederatedIdentityCredentialsGetOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type FederatedIdentityCredentialsGetResponse = FederatedIdentityCredential;
+
+// @public
+export interface FederatedIdentityCredentialsListNextOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type FederatedIdentityCredentialsListNextResponse = FederatedIdentityCredentialsListResult;
+
+// @public
+export interface FederatedIdentityCredentialsListOptionalParams extends coreClient.OperationOptions {
+    skiptoken?: string;
+    top?: number;
+}
+
+// @public
+export type FederatedIdentityCredentialsListResponse = FederatedIdentityCredentialsListResult;
+
+// @public
+export interface FederatedIdentityCredentialsListResult {
+    nextLink?: string;
+    value?: FederatedIdentityCredential[];
+}
+
+// @public
+export function getContinuationToken(page: unknown): string | undefined;
+
+// @public
+export interface Identity extends TrackedResource {
     readonly clientId?: string;
-};
+    readonly principalId?: string;
+    readonly tenantId?: string;
+}
 
 // @public
-export type IdentityUpdate = Resource & {
+export interface IdentityUpdate extends Resource {
+    readonly clientId?: string;
     location?: string;
+    readonly principalId?: string;
     tags?: {
         [propertyName: string]: string;
     };
     readonly tenantId?: string;
-    readonly principalId?: string;
-    readonly clientId?: string;
-};
+}
+
+// @public
+export enum KnownCreatedByType {
+    Application = "Application",
+    Key = "Key",
+    ManagedIdentity = "ManagedIdentity",
+    User = "User"
+}
 
 // @public (undocumented)
 export class ManagedServiceIdentityClient extends coreClient.ServiceClient {
@@ -64,6 +116,8 @@ export class ManagedServiceIdentityClient extends coreClient.ServiceClient {
     // (undocumented)
     apiVersion: string;
     // (undocumented)
+    federatedIdentityCredentials: FederatedIdentityCredentials;
+    // (undocumented)
     operations: Operations;
     // (undocumented)
     subscriptionId: string;
@@ -120,12 +174,14 @@ export interface OperationsListOptionalParams extends coreClient.OperationOption
 export type OperationsListResponse = OperationListResult;
 
 // @public
-export type ProxyResource = Resource & {};
+export interface ProxyResource extends Resource {
+}
 
 // @public
 export interface Resource {
     readonly id?: string;
     readonly name?: string;
+    readonly systemData?: SystemData;
     readonly type?: string;
 }
 
@@ -142,31 +198,40 @@ export interface SystemAssignedIdentitiesGetByScopeOptionalParams extends coreCl
 export type SystemAssignedIdentitiesGetByScopeResponse = SystemAssignedIdentity;
 
 // @public
-export type SystemAssignedIdentity = ProxyResource & {
+export interface SystemAssignedIdentity extends ProxyResource {
+    readonly clientId?: string;
+    readonly clientSecretUrl?: string;
     location: string;
+    readonly principalId?: string;
     tags?: {
         [propertyName: string]: string;
     };
     readonly tenantId?: string;
-    readonly principalId?: string;
-    readonly clientId?: string;
-    readonly clientSecretUrl?: string;
-};
+}
+
+// @public
+export interface SystemData {
+    createdAt?: Date;
+    createdBy?: string;
+    createdByType?: CreatedByType;
+    lastModifiedAt?: Date;
+    lastModifiedBy?: string;
+    lastModifiedByType?: CreatedByType;
+}
 
 // @public
-export type TrackedResource = Resource & {
+export interface TrackedResource extends Resource {
+    location: string;
     tags?: {
         [propertyName: string]: string;
     };
-    location: string;
-};
+}
 
 // @public
 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>;
@@ -190,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

@@ -7,16 +7,24 @@
  */
 
 import * as coreClient from "@azure/core-client";
+import * as coreRestPipeline from "@azure/core-rest-pipeline";
+import {
+  PipelineRequest,
+  PipelineResponse,
+  SendRequest
+} from "@azure/core-rest-pipeline";
 import * as coreAuth from "@azure/core-auth";
 import {
   SystemAssignedIdentitiesImpl,
   OperationsImpl,
-  UserAssignedIdentitiesImpl
+  UserAssignedIdentitiesImpl,
+  FederatedIdentityCredentialsImpl
 } from "./operations";
 import {
   SystemAssignedIdentities,
   Operations,
-  UserAssignedIdentities
+  UserAssignedIdentities,
+  FederatedIdentityCredentials
 } from "./operationsInterfaces";
 import { ManagedServiceIdentityClientOptionalParams } from "./models";
 
@@ -52,37 +60,99 @@ export class ManagedServiceIdentityClient extends coreClient.ServiceClient {
       credential: credentials
     };
 
-    const packageDetails = `azsdk-js-arm-msi/2.1.0-beta.1`;
+    const packageDetails = `azsdk-js-arm-msi/2.1.0`;
     const userAgentPrefix =
       options.userAgentOptions && options.userAgentOptions.userAgentPrefix
         ? `${options.userAgentOptions.userAgentPrefix} ${packageDetails}`
         : `${packageDetails}`;
 
-    if (!options.credentialScopes) {
-      options.credentialScopes = ["https://management.azure.com/.default"];
-    }
     const optionsWithDefaults = {
       ...defaults,
       ...options,
       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();
+      bearerTokenAuthenticationPolicyFound = pipelinePolicies.some(
+        (pipelinePolicy) =>
+          pipelinePolicy.name ===
+          coreRestPipeline.bearerTokenAuthenticationPolicyName
+      );
+    }
+    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 || "2021-09-30-preview";
+    this.apiVersion = options.apiVersion || "2023-01-31";
     this.systemAssignedIdentities = new SystemAssignedIdentitiesImpl(this);
     this.operations = new OperationsImpl(this);
     this.userAssignedIdentities = new UserAssignedIdentitiesImpl(this);
+    this.federatedIdentityCredentials = new FederatedIdentityCredentialsImpl(
+      this
+    );
+    this.addCustomApiVersionPolicy(options.apiVersion);
+  }
+
+  /** A function that adds a policy that sets the api-version (or equivalent) to reflect the library version. */
+  private addCustomApiVersionPolicy(apiVersion?: string) {
+    if (!apiVersion) {
+      return;
+    }
+    const apiVersionPolicy = {
+      name: "CustomApiVersionPolicy",
+      async sendRequest(
+        request: PipelineRequest,
+        next: SendRequest
+      ): Promise<PipelineResponse> {
+        const param = request.url.split("?");
+        if (param.length > 1) {
+          const newParams = param[1].split("&").map((item) => {
+            if (item.indexOf("api-version") > -1) {
+              return "api-version=" + apiVersion;
+            } else {
+              return item;
+            }
+          });
+          request.url = param[0] + "?" + newParams.join("&");
+        }
+        return next(request);
+      }
+    };
+    this.pipeline.addPolicy(apiVersionPolicy);
   }
 
   systemAssignedIdentities: SystemAssignedIdentities;
   operations: Operations;
   userAssignedIdentities: UserAssignedIdentities;
+  federatedIdentityCredentials: FederatedIdentityCredentials;
 }

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,72 +102,27 @@ 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. */
+  value?: FederatedIdentityCredential[];
+  /** The url to get the next page of results, if any. */
+  nextLink?: string;
 }
 
 /** The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location */
-export type ProxyResource = Resource & {};
+export interface ProxyResource extends Resource {}
 
 /** The resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a 'location' */
-export type TrackedResource = Resource & {
+export interface TrackedResource extends Resource {
   /** Resource tags. */
   tags?: { [propertyName: string]: string };
   /** The geo-location where the resource lives */
   location: string;
-};
+}
 
 /** Describes an identity resource. */
-export type IdentityUpdate = Resource & {
+export interface IdentityUpdate extends Resource {
   /** The geo-location where the resource lives */
   location?: string;
   /** Resource tags */
@@ -166,10 +142,10 @@ export type IdentityUpdate = Resource & {
    * NOTE: This property will not be serialized. It can only be populated by the server.
    */
   readonly clientId?: string;
-};
+}
 
 /** Describes a system assigned identity resource. */
-export type SystemAssignedIdentity = ProxyResource & {
+export interface SystemAssignedIdentity extends ProxyResource {
   /** The geo-location where the resource lives */
   location: string;
   /** Resource tags */
@@ -194,10 +170,20 @@ export type SystemAssignedIdentity = ProxyResource & {
    * NOTE: This property will not be serialized. It can only be populated by the server.
    */
   readonly clientSecretUrl?: string;
-};
+}
+
+/** Describes a federated identity credential. */
+export interface FederatedIdentityCredential extends ProxyResource {
+  /** The URL of the issuer to be trusted. */
+  issuer?: string;
+  /** The identifier of the external identity. */
+  subject?: string;
+  /** The list of audiences that can appear in the issued token. */
+  audiences?: string[];
+}
 
 /** Describes an identity resource. */
-export type Identity = TrackedResource & {
+export interface Identity extends TrackedResource {
   /**
    * The id of the tenant which the identity belongs to.
    * NOTE: This property will not be serialized. It can only be populated by the server.
@@ -213,7 +199,31 @@ export type Identity = TrackedResource & {
    * NOTE: This property will not be serialized. It can only be populated by the server.
    */
   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
@@ -250,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 {}
@@ -308,22 +300,41 @@ export interface UserAssignedIdentitiesListByResourceGroupNextOptionalParams
 export type UserAssignedIdentitiesListByResourceGroupNextResponse = UserAssignedIdentitiesListResult;
 
 /** Optional parameters. */
-export interface UserAssignedIdentitiesListAssociatedResourcesNextOptionalParams
+export interface FederatedIdentityCredentialsListOptionalParams
   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;
+/** Contains response data for the list operation. */
+export type FederatedIdentityCredentialsListResponse = FederatedIdentityCredentialsListResult;
+
+/** Optional parameters. */
+export interface FederatedIdentityCredentialsCreateOrUpdateOptionalParams
+  extends coreClient.OperationOptions {}
+
+/** Contains response data for the createOrUpdate operation. */
+export type FederatedIdentityCredentialsCreateOrUpdateResponse = FederatedIdentityCredential;
+
+/** Optional parameters. */
+export interface FederatedIdentityCredentialsGetOptionalParams
+  extends coreClient.OperationOptions {}
+
+/** Contains response data for the get operation. */
+export type FederatedIdentityCredentialsGetResponse = FederatedIdentityCredential;
+
+/** Optional parameters. */
+export interface FederatedIdentityCredentialsDeleteOptionalParams
+  extends coreClient.OperationOptions {}
+
+/** Optional parameters. */
+export interface FederatedIdentityCredentialsListNextOptionalParams
+  extends coreClient.OperationOptions {}
+
+/** Contains response data for the listNext operation. */
+export type FederatedIdentityCredentialsListNextResponse = FederatedIdentityCredentialsListResult;
 
 /** Optional parameters. */
 export interface ManagedServiceIdentityClientOptionalParams