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

package/types/arm-msi.d.ts

@@ -2,59 +2,6 @@ import * as coreAuth from '@azure/core-auth';
 import * as coreClient from '@azure/core-client';
 import { PagedAsyncIterableIterator } from '@azure/core-paging';
 
-/** Azure resources returned by the resource action to get a list of assigned resources. */
-export declare 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 declare 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;
-}
-
 /** An error response from the ManagedServiceIdentity service. */
 export declare interface CloudError {
     /** A list of additional details about the error. */
@@ -73,8 +20,122 @@ export declare interface CloudErrorBody {
     details?: CloudErrorBody[];
 }
 
+/**
+ * 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 declare type CreatedByType = string;
+
+/** Describes a federated identity credential. */
+export declare 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[];
+}
+
+/** Interface representing a FederatedIdentityCredentials. */
+export declare interface FederatedIdentityCredentials {
+    /**
+     * Lists all the federated identity credentials under the specified user assigned identity.
+     * @param resourceGroupName The name of the resource group. The name is case insensitive.
+     * @param resourceName The name of the identity resource.
+     * @param options The options parameters.
+     */
+    list(resourceGroupName: string, resourceName: string, options?: FederatedIdentityCredentialsListOptionalParams): PagedAsyncIterableIterator<FederatedIdentityCredential>;
+    /**
+     * Create or update a federated identity credential under the specified user assigned identity.
+     * @param resourceGroupName The name of the resource group. The name is case insensitive.
+     * @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>;
+    /**
+     * Gets the federated identity credential.
+     * @param resourceGroupName The name of the resource group. The name is case insensitive.
+     * @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>;
+    /**
+     * Deletes the federated identity credential.
+     * @param resourceGroupName The name of the resource group. The name is case insensitive.
+     * @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>;
+}
+
+/** Optional parameters. */
+export declare interface FederatedIdentityCredentialsCreateOrUpdateOptionalParams extends coreClient.OperationOptions {
+}
+
+/** Contains response data for the createOrUpdate operation. */
+export declare type FederatedIdentityCredentialsCreateOrUpdateResponse = FederatedIdentityCredential;
+
+/** Optional parameters. */
+export declare interface FederatedIdentityCredentialsDeleteOptionalParams extends coreClient.OperationOptions {
+}
+
+/** Optional parameters. */
+export declare interface FederatedIdentityCredentialsGetOptionalParams extends coreClient.OperationOptions {
+}
+
+/** Contains response data for the get operation. */
+export declare type FederatedIdentityCredentialsGetResponse = FederatedIdentityCredential;
+
+/** Optional parameters. */
+export declare interface FederatedIdentityCredentialsListNextOptionalParams extends coreClient.OperationOptions {
+}
+
+/** Contains response data for the listNext operation. */
+export declare type FederatedIdentityCredentialsListNextResponse = FederatedIdentityCredentialsListResult;
+
+/** Optional parameters. */
+export declare 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 declare type FederatedIdentityCredentialsListResponse = FederatedIdentityCredentialsListResult;
+
+/** Values returned by the List operation for federated identity credentials. */
+export declare 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;
+}
+
+/**
+ * Given the last `.value` produced by the `byPage` iterator,
+ * returns a continuation token that can be used to begin paging from
+ * that point later.
+ * @param page An object from accessing `value` on the IteratorResult from a `byPage` iterator.
+ * @returns The continuation token that can be passed into byPage() during future calls.
+ */
+export declare function getContinuationToken(page: unknown): string | undefined;
+
 /** Describes an identity resource. */
-export declare type Identity = TrackedResource & {
+export declare 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.
@@ -90,10 +151,10 @@ export declare type Identity = TrackedResource & {
      * NOTE: This property will not be serialized. It can only be populated by the server.
      */
     readonly clientId?: string;
-};
+}
 
 /** Describes an identity resource. */
-export declare type IdentityUpdate = Resource & {
+export declare interface IdentityUpdate extends Resource {
     /** The geo-location where the resource lives */
     location?: string;
     /** Resource tags */
@@ -115,7 +176,19 @@ export declare type IdentityUpdate = Resource & {
      * 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 declare enum KnownCreatedByType {
+    /** User */
+    User = "User",
+    /** Application */
+    Application = "Application",
+    /** ManagedIdentity */
+    ManagedIdentity = "ManagedIdentity",
+    /** Key */
+    Key = "Key"
+}
 
 export declare class ManagedServiceIdentityClient extends coreClient.ServiceClient {
     $host: string;
@@ -128,9 +201,12 @@ export declare class ManagedServiceIdentityClient extends coreClient.ServiceClie
      * @param options The parameter options
      */
     constructor(credentials: coreAuth.TokenCredential, subscriptionId: string, options?: ManagedServiceIdentityClientOptionalParams);
+    /** A function that adds a policy that sets the api-version (or equivalent) to reflect the library version. */
+    private addCustomApiVersionPolicy;
     systemAssignedIdentities: SystemAssignedIdentities;
     operations: Operations;
     userAssignedIdentities: UserAssignedIdentities;
+    federatedIdentityCredentials: FederatedIdentityCredentials;
 }
 
 /** Optional parameters. */
@@ -195,12 +271,13 @@ export declare interface OperationsListOptionalParams extends coreClient.Operati
 export declare type OperationsListResponse = OperationListResult;
 
 /** The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location */
-export declare type ProxyResource = Resource & {};
+export declare interface ProxyResource extends Resource {
+}
 
 /** Common fields that are returned in the response for all Azure Resource Manager resources */
 export declare 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;
@@ -214,6 +291,11 @@ export declare 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;
 }
 
 /** Interface representing a SystemAssignedIdentities. */
@@ -235,7 +317,7 @@ export declare interface SystemAssignedIdentitiesGetByScopeOptionalParams extend
 export declare type SystemAssignedIdentitiesGetByScopeResponse = SystemAssignedIdentity;
 
 /** Describes a system assigned identity resource. */
-export declare type SystemAssignedIdentity = ProxyResource & {
+export declare interface SystemAssignedIdentity extends ProxyResource {
     /** The geo-location where the resource lives */
     location: string;
     /** Resource tags */
@@ -262,17 +344,33 @@ export declare type SystemAssignedIdentity = ProxyResource & {
      * NOTE: This property will not be serialized. It can only be populated by the server.
      */
     readonly clientSecretUrl?: string;
-};
+}
+
+/** Metadata pertaining to creation and last modification of the resource. */
+export declare 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;
+}
 
 /** The resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a 'location' */
-export declare type TrackedResource = Resource & {
+export declare interface TrackedResource extends Resource {
     /** Resource tags. */
     tags?: {
         [propertyName: string]: string;
     };
     /** The geo-location where the resource lives */
     location: string;
-};
+}
 
 /** Interface representing a UserAssignedIdentities. */
 export declare interface UserAssignedIdentities {
@@ -287,13 +385,6 @@ export declare interface UserAssignedIdentities {
      * @param options The options parameters.
      */
     listByResourceGroup(resourceGroupName: string, options?: UserAssignedIdentitiesListByResourceGroupOptionalParams): PagedAsyncIterableIterator<Identity>;
-    /**
-     * Lists the associated resources for this 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.
-     */
-    listAssociatedResources(resourceGroupName: string, resourceName: string, options?: UserAssignedIdentitiesListAssociatedResourcesOptionalParams): PagedAsyncIterableIterator<AzureResource>;
     /**
      * Create or update an identity in the specified subscription and resource group.
      * @param resourceGroupName The name of the Resource Group to which the identity belongs.
@@ -344,40 +435,6 @@ export declare interface UserAssignedIdentitiesGetOptionalParams extends coreCli
 /** Contains response data for the get operation. */
 export declare type UserAssignedIdentitiesGetResponse = Identity;
 
-/** Optional parameters. */
-export declare 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 declare type UserAssignedIdentitiesListAssociatedResourcesNextResponse = AssociatedResourcesListResult;
-
-/** Optional parameters. */
-export declare 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 declare type UserAssignedIdentitiesListAssociatedResourcesResponse = AssociatedResourcesListResult;
-
 /** Optional parameters. */
 export declare interface UserAssignedIdentitiesListByResourceGroupNextOptionalParams extends coreClient.OperationOptions {
 }

package/types/tsdoc-metadata.json

@@ -5,7 +5,7 @@
   "toolPackages": [
     {
       "packageName": "@microsoft/api-extractor",
-      "packageVersion": "7.19.4"
+      "packageVersion": "7.34.2"
     }
   ]
 }

package/dist-esm/samples-dev/userAssignedIdentitiesListAssociatedResourcesSample.d.ts

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=userAssignedIdentitiesListAssociatedResourcesSample.d.ts.map

package/dist-esm/samples-dev/userAssignedIdentitiesListAssociatedResourcesSample.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"userAssignedIdentitiesListAssociatedResourcesSample.d.ts","sourceRoot":"","sources":["../../samples-dev/userAssignedIdentitiesListAssociatedResourcesSample.ts"],"names":[],"mappings":""}

package/dist-esm/samples-dev/userAssignedIdentitiesListAssociatedResourcesSample.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"userAssignedIdentitiesListAssociatedResourcesSample.js","sourceRoot":"","sources":["../../samples-dev/userAssignedIdentitiesListAssociatedResourcesSample.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;;AAEH,uCAAuC;AACvC,kCAAkC;AAClC,OAAO,EAEL,4BAA4B,EAC7B,MAAM,gBAAgB,CAAC;AACxB,OAAO,EAAE,sBAAsB,EAAE,MAAM,iBAAiB,CAAC;AAEzD;;;;;GAKG;AACH,SAAe,+BAA+B;;;QAC5C,MAAM,cAAc,GAAG,sCAAsC,CAAC;QAC9D,MAAM,iBAAiB,GAAG,QAAQ,CAAC;QACnC,MAAM,YAAY,GAAG,QAAQ,CAAC;QAC9B,MAAM,MAAM,GAAG,wBAAwB,CAAC;QACxC,MAAM,OAAO,GAAG,UAAU,CAAC;QAC3B,MAAM,GAAG,GAAG,EAAE,CAAC;QACf,MAAM,IAAI,GAAG,CAAC,CAAC;QACf,MAAM,OAAO,GAAgE;YAC3E,MAAM;YACN,OAAO;YACP,GAAG;YACH,IAAI;SACL,CAAC;QACF,MAAM,UAAU,GAAG,IAAI,sBAAsB,EAAE,CAAC;QAChD,MAAM,MAAM,GAAG,IAAI,4BAA4B,CAAC,UAAU,EAAE,cAAc,CAAC,CAAC;QAC5E,MAAM,QAAQ,GAAG,IAAI,KAAK,EAAE,CAAC;;YAC7B,KAAuB,IAAA,KAAA,cAAA,MAAM,CAAC,sBAAsB,CAAC,uBAAuB,CAC1E,iBAAiB,EACjB,YAAY,EACZ,OAAO,CACR,CAAA,IAAA;gBAJU,IAAI,IAAI,WAAA,CAAA;gBAKjB,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;aACrB;;;;;;;;;QACD,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;;CACvB;AAED,+BAA+B,EAAE,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC"}