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

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,15 +60,12 @@ 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-beta.2`;
     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,
@@ -71,18 +76,74 @@ export class ManagedServiceIdentityClient extends coreClient.ServiceClient {
         options.endpoint ?? options.baseUri ?? "https://management.azure.com"
     };
     super(optionsWithDefaults);
+
+    if (options?.pipeline && options.pipeline.getOrderedPolicies().length > 0) {
+      const pipelinePolicies: coreRestPipeline.PipelinePolicy[] = options.pipeline.getOrderedPolicies();
+      const 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
+            }
+          })
+        );
+      }
+    }
     // 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 || "2022-01-31-preview";
     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

@@ -134,19 +134,27 @@ export interface AzureResource {
   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 +174,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 +202,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 +231,7 @@ export type Identity = TrackedResource & {
    * NOTE: This property will not be serialized. It can only be populated by the server.
    */
   readonly clientId?: string;
-};
+}
 
 /** Optional parameters. */
 export interface SystemAssignedIdentitiesGetByScopeOptionalParams
@@ -325,6 +343,48 @@ export interface UserAssignedIdentitiesListAssociatedResourcesNextOptionalParams
 /** Contains response data for the listAssociatedResourcesNext operation. */
 export type UserAssignedIdentitiesListAssociatedResourcesNextResponse = AssociatedResourcesListResult;
 
+/** Optional parameters. */
+export interface FederatedIdentityCredentialsListOptionalParams
+  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;
+}
+
+/** 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 {
+  /** 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;
+}
+
+/** Contains response data for the listNext operation. */
+export type FederatedIdentityCredentialsListNextResponse = FederatedIdentityCredentialsListResult;
+
 /** Optional parameters. */
 export interface ManagedServiceIdentityClientOptionalParams
   extends coreClient.ServiceClientOptions {

package/src/models/mappers.ts

@@ -289,6 +289,33 @@ export const AzureResource: coreClient.CompositeMapper = {
   }
 };
 
+export const FederatedIdentityCredentialsListResult: coreClient.CompositeMapper = {
+  type: {
+    name: "Composite",
+    className: "FederatedIdentityCredentialsListResult",
+    modelProperties: {
+      value: {
+        serializedName: "value",
+        type: {
+          name: "Sequence",
+          element: {
+            type: {
+              name: "Composite",
+              className: "FederatedIdentityCredential"
+            }
+          }
+        }
+      },
+      nextLink: {
+        serializedName: "nextLink",
+        type: {
+          name: "String"
+        }
+      }
+    }
+  }
+};
+
 export const ProxyResource: coreClient.CompositeMapper = {
   type: {
     name: "Composite",
@@ -419,6 +446,39 @@ export const SystemAssignedIdentity: coreClient.CompositeMapper = {
   }
 };
 
+export const FederatedIdentityCredential: coreClient.CompositeMapper = {
+  type: {
+    name: "Composite",
+    className: "FederatedIdentityCredential",
+    modelProperties: {
+      ...ProxyResource.type.modelProperties,
+      issuer: {
+        serializedName: "properties.issuer",
+        type: {
+          name: "String"
+        }
+      },
+      subject: {
+        serializedName: "properties.subject",
+        type: {
+          name: "String"
+        }
+      },
+      audiences: {
+        serializedName: "properties.audiences",
+        type: {
+          name: "Sequence",
+          element: {
+            type: {
+              name: "String"
+            }
+          }
+        }
+      }
+    }
+  }
+};
+
 export const Identity: coreClient.CompositeMapper = {
   type: {
     name: "Composite",

package/src/models/parameters.ts

@@ -13,7 +13,8 @@ import {
 } from "@azure/core-client";
 import {
   Identity as IdentityMapper,
-  IdentityUpdate as IdentityUpdateMapper
+  IdentityUpdate as IdentityUpdateMapper,
+  FederatedIdentityCredential as FederatedIdentityCredentialMapper
 } from "../models/mappers";
 
 export const accept: OperationParameter = {
@@ -55,7 +56,7 @@ export const scope: OperationURLParameter = {
 export const apiVersion: OperationQueryParameter = {
   parameterPath: "apiVersion",
   mapper: {
-    defaultValue: "2021-09-30-preview",
+    defaultValue: "2022-01-31-preview",
     isConstant: true,
     serializedName: "api-version",
     type: {
@@ -186,3 +187,19 @@ export const parameters1: OperationParameter = {
   parameterPath: "parameters",
   mapper: IdentityUpdateMapper
 };
+
+export const parameters2: OperationParameter = {
+  parameterPath: "parameters",
+  mapper: FederatedIdentityCredentialMapper
+};
+
+export const federatedIdentityCredentialResourceName: OperationURLParameter = {
+  parameterPath: "federatedIdentityCredentialResourceName",
+  mapper: {
+    serializedName: "federatedIdentityCredentialResourceName",
+    required: true,
+    type: {
+      name: "String"
+    }
+  }
+};

package/src/operations/federatedIdentityCredentials.ts

@@ -0,0 +1,342 @@
+/*
+ * Copyright (c) Microsoft Corporation.
+ * Licensed under the MIT License.
+ *
+ * Code generated by Microsoft (R) AutoRest Code Generator.
+ * Changes may cause incorrect behavior and will be lost if the code is regenerated.
+ */
+
+import { PagedAsyncIterableIterator } from "@azure/core-paging";
+import { FederatedIdentityCredentials } from "../operationsInterfaces";
+import * as coreClient from "@azure/core-client";
+import * as Mappers from "../models/mappers";
+import * as Parameters from "../models/parameters";
+import { ManagedServiceIdentityClient } from "../managedServiceIdentityClient";
+import {
+  FederatedIdentityCredential,
+  FederatedIdentityCredentialsListNextOptionalParams,
+  FederatedIdentityCredentialsListOptionalParams,
+  FederatedIdentityCredentialsListResponse,
+  FederatedIdentityCredentialsCreateOrUpdateOptionalParams,
+  FederatedIdentityCredentialsCreateOrUpdateResponse,
+  FederatedIdentityCredentialsGetOptionalParams,
+  FederatedIdentityCredentialsGetResponse,
+  FederatedIdentityCredentialsDeleteOptionalParams,
+  FederatedIdentityCredentialsListNextResponse
+} from "../models";
+
+/// <reference lib="esnext.asynciterable" />
+/** Class containing FederatedIdentityCredentials operations. */
+export class FederatedIdentityCredentialsImpl
+  implements FederatedIdentityCredentials {
+  private readonly client: ManagedServiceIdentityClient;
+
+  /**
+   * Initialize a new instance of the class FederatedIdentityCredentials class.
+   * @param client Reference to the service client
+   */
+  constructor(client: ManagedServiceIdentityClient) {
+    this.client = client;
+  }
+
+  /**
+   * Lists all the federated identity credentials under the specified user assigned identity.
+   * @param resourceGroupName The name of the Resource Group to which the identity belongs.
+   * @param resourceName The name of the identity resource.
+   * @param options The options parameters.
+   */
+  public list(
+    resourceGroupName: string,
+    resourceName: string,
+    options?: FederatedIdentityCredentialsListOptionalParams
+  ): PagedAsyncIterableIterator<FederatedIdentityCredential> {
+    const iter = this.listPagingAll(resourceGroupName, resourceName, options);
+    return {
+      next() {
+        return iter.next();
+      },
+      [Symbol.asyncIterator]() {
+        return this;
+      },
+      byPage: () => {
+        return this.listPagingPage(resourceGroupName, resourceName, options);
+      }
+    };
+  }
+
+  private async *listPagingPage(
+    resourceGroupName: string,
+    resourceName: string,
+    options?: FederatedIdentityCredentialsListOptionalParams
+  ): AsyncIterableIterator<FederatedIdentityCredential[]> {
+    let result = await this._list(resourceGroupName, resourceName, options);
+    yield result.value || [];
+    let continuationToken = result.nextLink;
+    while (continuationToken) {
+      result = await this._listNext(
+        resourceGroupName,
+        resourceName,
+        continuationToken,
+        options
+      );
+      continuationToken = result.nextLink;
+      yield result.value || [];
+    }
+  }
+
+  private async *listPagingAll(
+    resourceGroupName: string,
+    resourceName: string,
+    options?: FederatedIdentityCredentialsListOptionalParams
+  ): AsyncIterableIterator<FederatedIdentityCredential> {
+    for await (const page of this.listPagingPage(
+      resourceGroupName,
+      resourceName,
+      options
+    )) {
+      yield* page;
+    }
+  }
+
+  /**
+   * Lists all the federated identity credentials under the specified user assigned identity.
+   * @param resourceGroupName The name of the Resource Group to which the identity belongs.
+   * @param resourceName The name of the identity resource.
+   * @param options The options parameters.
+   */
+  private _list(
+    resourceGroupName: string,
+    resourceName: string,
+    options?: FederatedIdentityCredentialsListOptionalParams
+  ): Promise<FederatedIdentityCredentialsListResponse> {
+    return this.client.sendOperationRequest(
+      { resourceGroupName, resourceName, options },
+      listOperationSpec
+    );
+  }
+
+  /**
+   * Create or update a federated identity credential under the specified user assigned identity.
+   * @param resourceGroupName The name of the Resource Group to which the identity belongs.
+   * @param resourceName The name of the identity resource.
+   * @param federatedIdentityCredentialResourceName The name of the federated identity credential
+   *                                                resource.
+   * @param parameters Parameters to create or update the federated identity credential.
+   * @param options The options parameters.
+   */
+  createOrUpdate(
+    resourceGroupName: string,
+    resourceName: string,
+    federatedIdentityCredentialResourceName: string,
+    parameters: FederatedIdentityCredential,
+    options?: FederatedIdentityCredentialsCreateOrUpdateOptionalParams
+  ): Promise<FederatedIdentityCredentialsCreateOrUpdateResponse> {
+    return this.client.sendOperationRequest(
+      {
+        resourceGroupName,
+        resourceName,
+        federatedIdentityCredentialResourceName,
+        parameters,
+        options
+      },
+      createOrUpdateOperationSpec
+    );
+  }
+
+  /**
+   * Gets the federated identity credential.
+   * @param resourceGroupName The name of the Resource Group to which the identity belongs.
+   * @param resourceName The name of the identity resource.
+   * @param federatedIdentityCredentialResourceName The name of the federated identity credential
+   *                                                resource.
+   * @param options The options parameters.
+   */
+  get(
+    resourceGroupName: string,
+    resourceName: string,
+    federatedIdentityCredentialResourceName: string,
+    options?: FederatedIdentityCredentialsGetOptionalParams
+  ): Promise<FederatedIdentityCredentialsGetResponse> {
+    return this.client.sendOperationRequest(
+      {
+        resourceGroupName,
+        resourceName,
+        federatedIdentityCredentialResourceName,
+        options
+      },
+      getOperationSpec
+    );
+  }
+
+  /**
+   * Deletes the federated identity credential.
+   * @param resourceGroupName The name of the Resource Group to which the identity belongs.
+   * @param resourceName The name of the identity resource.
+   * @param federatedIdentityCredentialResourceName The name of the federated identity credential
+   *                                                resource.
+   * @param options The options parameters.
+   */
+  delete(
+    resourceGroupName: string,
+    resourceName: string,
+    federatedIdentityCredentialResourceName: string,
+    options?: FederatedIdentityCredentialsDeleteOptionalParams
+  ): Promise<void> {
+    return this.client.sendOperationRequest(
+      {
+        resourceGroupName,
+        resourceName,
+        federatedIdentityCredentialResourceName,
+        options
+      },
+      deleteOperationSpec
+    );
+  }
+
+  /**
+   * ListNext
+   * @param resourceGroupName The name of the Resource Group to which the identity belongs.
+   * @param resourceName The name of the identity resource.
+   * @param nextLink The nextLink from the previous successful call to the List method.
+   * @param options The options parameters.
+   */
+  private _listNext(
+    resourceGroupName: string,
+    resourceName: string,
+    nextLink: string,
+    options?: FederatedIdentityCredentialsListNextOptionalParams
+  ): Promise<FederatedIdentityCredentialsListNextResponse> {
+    return this.client.sendOperationRequest(
+      { resourceGroupName, resourceName, nextLink, options },
+      listNextOperationSpec
+    );
+  }
+}
+// Operation Specifications
+const serializer = coreClient.createSerializer(Mappers, /* isXml */ false);
+
+const listOperationSpec: coreClient.OperationSpec = {
+  path:
+    "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{resourceName}/federatedIdentityCredentials",
+  httpMethod: "GET",
+  responses: {
+    200: {
+      bodyMapper: Mappers.FederatedIdentityCredentialsListResult
+    },
+    default: {
+      bodyMapper: Mappers.CloudError
+    }
+  },
+  queryParameters: [
+    Parameters.apiVersion,
+    Parameters.top,
+    Parameters.skiptoken
+  ],
+  urlParameters: [
+    Parameters.$host,
+    Parameters.subscriptionId,
+    Parameters.resourceGroupName,
+    Parameters.resourceName
+  ],
+  headerParameters: [Parameters.accept],
+  serializer
+};
+const createOrUpdateOperationSpec: coreClient.OperationSpec = {
+  path:
+    "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{resourceName}/federatedIdentityCredentials/{federatedIdentityCredentialResourceName}",
+  httpMethod: "PUT",
+  responses: {
+    200: {
+      bodyMapper: Mappers.FederatedIdentityCredential
+    },
+    201: {
+      bodyMapper: Mappers.FederatedIdentityCredential
+    },
+    default: {
+      bodyMapper: Mappers.CloudError
+    }
+  },
+  requestBody: Parameters.parameters2,
+  queryParameters: [Parameters.apiVersion],
+  urlParameters: [
+    Parameters.$host,
+    Parameters.subscriptionId,
+    Parameters.resourceGroupName,
+    Parameters.resourceName,
+    Parameters.federatedIdentityCredentialResourceName
+  ],
+  headerParameters: [Parameters.accept, Parameters.contentType],
+  mediaType: "json",
+  serializer
+};
+const getOperationSpec: coreClient.OperationSpec = {
+  path:
+    "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{resourceName}/federatedIdentityCredentials/{federatedIdentityCredentialResourceName}",
+  httpMethod: "GET",
+  responses: {
+    200: {
+      bodyMapper: Mappers.FederatedIdentityCredential
+    },
+    default: {
+      bodyMapper: Mappers.CloudError
+    }
+  },
+  queryParameters: [Parameters.apiVersion],
+  urlParameters: [
+    Parameters.$host,
+    Parameters.subscriptionId,
+    Parameters.resourceGroupName,
+    Parameters.resourceName,
+    Parameters.federatedIdentityCredentialResourceName
+  ],
+  headerParameters: [Parameters.accept],
+  serializer
+};
+const deleteOperationSpec: coreClient.OperationSpec = {
+  path:
+    "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{resourceName}/federatedIdentityCredentials/{federatedIdentityCredentialResourceName}",
+  httpMethod: "DELETE",
+  responses: {
+    200: {},
+    204: {},
+    default: {
+      bodyMapper: Mappers.CloudError
+    }
+  },
+  queryParameters: [Parameters.apiVersion],
+  urlParameters: [
+    Parameters.$host,
+    Parameters.subscriptionId,
+    Parameters.resourceGroupName,
+    Parameters.resourceName,
+    Parameters.federatedIdentityCredentialResourceName
+  ],
+  headerParameters: [Parameters.accept],
+  serializer
+};
+const listNextOperationSpec: coreClient.OperationSpec = {
+  path: "{nextLink}",
+  httpMethod: "GET",
+  responses: {
+    200: {
+      bodyMapper: Mappers.FederatedIdentityCredentialsListResult
+    },
+    default: {
+      bodyMapper: Mappers.CloudError
+    }
+  },
+  queryParameters: [
+    Parameters.apiVersion,
+    Parameters.top,
+    Parameters.skiptoken
+  ],
+  urlParameters: [
+    Parameters.$host,
+    Parameters.nextLink,
+    Parameters.subscriptionId,
+    Parameters.resourceGroupName,
+    Parameters.resourceName
+  ],
+  headerParameters: [Parameters.accept],
+  serializer
+};