@azure/arm-msi 2.2.0 → 2.3.0-beta.1

package/dist/esm/models/models.d.ts

@@ -0,0 +1,310 @@
+/**
+ * This file contains only generated model types and their (de)serializers.
+ * Disable the following rules for internal models with '_' prefix and deserializers which require 'any' for raw JSON input.
+ */
+/** A list of REST API operations supported by an Azure Resource Provider. It contains an URL link to get the next set of results. */
+export interface _OperationListResult {
+    /** The Operation items on this page */
+    value: Operation[];
+    /** The link to the next page of items */
+    nextLink?: string;
+}
+export declare function _operationListResultDeserializer(item: any): _OperationListResult;
+export declare function operationArrayDeserializer(result: Array<Operation>): any[];
+/** Details of a REST API operation, returned from the Resource Provider Operations API */
+export interface Operation {
+    /** The name of the operation, as per Resource-Based Access Control (RBAC). Examples: "Microsoft.Compute/virtualMachines/write", "Microsoft.Compute/virtualMachines/capture/action" */
+    name?: string;
+    /** Localized display information for this particular operation. */
+    display?: OperationDisplay;
+}
+export declare function operationDeserializer(item: any): Operation;
+/** Localized display information for and operation. */
+export interface OperationDisplay {
+    /** The localized friendly form of the resource provider name, e.g. "Microsoft Monitoring Insights" or "Microsoft Compute". */
+    provider?: string;
+    /** The concise, localized friendly name for the operation; suitable for dropdowns. E.g. "Create or Update Virtual Machine", "Restart Virtual Machine". */
+    operation?: string;
+    /** The localized friendly name of the resource type related to this operation. E.g. "Virtual Machines" or "Job Schedule Collections". */
+    resource?: string;
+    /** The short, localized friendly description of the operation; suitable for tool tips and detailed views. */
+    description?: string;
+}
+export declare function operationDisplayDeserializer(item: any): OperationDisplay;
+/** An error response from the ManagedServiceIdentity service. */
+export interface CloudError {
+    /** A list of additional details about the error. */
+    error?: CloudErrorBody;
+}
+export declare function cloudErrorDeserializer(item: any): CloudError;
+/** An error response from the ManagedServiceIdentity service. */
+export interface CloudErrorBody {
+    /** An identifier for the error. */
+    code?: string;
+    /** A message describing the error, intended to be suitable for display in a user interface. */
+    message?: string;
+    /** The target of the particular error. For example, the name of the property in error. */
+    target?: string;
+    /** A list of additional details about the error. */
+    details?: CloudErrorBody[];
+}
+export declare function cloudErrorBodyDeserializer(item: any): CloudErrorBody;
+export declare function cloudErrorBodyArrayDeserializer(result: Array<CloudErrorBody>): any[];
+/** Describes a system assigned identity resource. */
+export interface SystemAssignedIdentity extends ExtensionResource {
+    location: string;
+    tags?: Record<string, string>;
+    /** The id of the tenant which the identity belongs to. */
+    readonly tenantId?: string;
+    /** The id of the service principal object associated with the created identity. */
+    readonly principalId?: string;
+    /** The id of the app associated with the identity. This is a random generated UUID by MSI. */
+    readonly clientId?: string;
+    /** The ManagedServiceIdentity DataPlane URL that can be queried to obtain the identity credentials. */
+    readonly clientSecretUrl?: string;
+}
+export declare function systemAssignedIdentityDeserializer(item: any): SystemAssignedIdentity;
+/** The properties associated with the system assigned identity. */
+export interface SystemAssignedIdentityProperties {
+    /** The id of the tenant which the identity belongs to. */
+    readonly tenantId?: string;
+    /** The id of the service principal object associated with the created identity. */
+    readonly principalId?: string;
+    /** The id of the app associated with the identity. This is a random generated UUID by MSI. */
+    readonly clientId?: string;
+    /** The ManagedServiceIdentity DataPlane URL that can be queried to obtain the identity credentials. */
+    readonly clientSecretUrl?: string;
+}
+export declare function systemAssignedIdentityPropertiesDeserializer(item: any): SystemAssignedIdentityProperties;
+/** The base extension resource. */
+export interface ExtensionResource extends Resource {
+}
+export declare function extensionResourceDeserializer(item: any): ExtensionResource;
+/** 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} */
+    readonly id?: string;
+    /** The name of the resource */
+    readonly name?: string;
+    /** The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" */
+    readonly type?: string;
+    /** Azure Resource Manager metadata containing createdBy and modifiedBy information. */
+    readonly systemData?: SystemData;
+}
+export declare function resourceSerializer(_item: Resource): any;
+export declare function resourceDeserializer(item: any): Resource;
+/** 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;
+}
+export declare function systemDataDeserializer(item: any): SystemData;
+/** The kind of entity that created the resource. */
+export declare enum KnownCreatedByType {
+    /** The entity was created by a user. */
+    User = "User",
+    /** The entity was created by an application. */
+    Application = "Application",
+    /** The entity was created by a managed identity. */
+    ManagedIdentity = "ManagedIdentity",
+    /** The entity was created by a key. */
+    Key = "Key"
+}
+/**
+ * The kind of entity that created the resource. \
+ * {@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**: The entity was created by a user. \
+ * **Application**: The entity was created by an application. \
+ * **ManagedIdentity**: The entity was created by a managed identity. \
+ * **Key**: The entity was created by a key.
+ */
+export type CreatedByType = 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[];
+    /** Object for defining the allowed identifiers of external identities. Either 'subject' or 'claimsMatchingExpression' must be defined, but not both. Introduced in 2025-01-31-preview. */
+    claimsMatchingExpression?: ClaimsMatchingExpression;
+}
+export declare function federatedIdentityCredentialSerializer(item: FederatedIdentityCredential): any;
+export declare function federatedIdentityCredentialDeserializer(item: any): FederatedIdentityCredential;
+/** The properties associated with a federated identity credential. */
+export interface FederatedIdentityCredentialProperties {
+    /** 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[];
+    /** Object for defining the allowed identifiers of external identities. Either 'subject' or 'claimsMatchingExpression' must be defined, but not both. Introduced in 2025-01-31-preview. */
+    claimsMatchingExpression?: ClaimsMatchingExpression;
+}
+export declare function federatedIdentityCredentialPropertiesSerializer(item: FederatedIdentityCredentialProperties): any;
+export declare function federatedIdentityCredentialPropertiesDeserializer(item: any): FederatedIdentityCredentialProperties;
+/** Object for defining the allowed identifiers of external identities. Introduced in 2025-01-31-preview. */
+export interface ClaimsMatchingExpression {
+    /** Wildcard-based expression for matching incoming subject claims. */
+    value: string;
+    /** Specifies the version of the flexible fic language used in the expression. */
+    languageVersion: number;
+}
+export declare function claimsMatchingExpressionSerializer(item: ClaimsMatchingExpression): any;
+export declare function claimsMatchingExpressionDeserializer(item: any): ClaimsMatchingExpression;
+/** The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location */
+export interface ProxyResource extends Resource {
+}
+export declare function proxyResourceSerializer(_item: ProxyResource): any;
+export declare function proxyResourceDeserializer(item: any): ProxyResource;
+/** Values returned by the List operation for federated identity credentials. */
+export interface _FederatedIdentityCredentialsListResult {
+    /** The FederatedIdentityCredential items on this page */
+    value: FederatedIdentityCredential[];
+    /** The link to the next page of items */
+    nextLink?: string;
+}
+export declare function _federatedIdentityCredentialsListResultDeserializer(item: any): _FederatedIdentityCredentialsListResult;
+export declare function federatedIdentityCredentialArraySerializer(result: Array<FederatedIdentityCredential>): any[];
+export declare function federatedIdentityCredentialArrayDeserializer(result: Array<FederatedIdentityCredential>): any[];
+/** Describes an identity resource. */
+export interface Identity extends TrackedResource {
+    /** The id of the tenant which the identity belongs to. */
+    readonly tenantId?: string;
+    /** The id of the service principal object associated with the created identity. */
+    readonly principalId?: string;
+    /** The id of the app associated with the identity. This is a random generated UUID by MSI. */
+    readonly clientId?: string;
+    /** Enum to configure regional restrictions on identity assignment, as necessary. */
+    isolationScope?: IsolationScope;
+    /** Restrictions on which resource providers this identity can be assigned to. */
+    assignmentRestrictions?: AssignmentRestrictions;
+}
+export declare function identitySerializer(item: Identity): any;
+export declare function identityDeserializer(item: any): Identity;
+/** The properties associated with the user assigned identity. */
+export interface UserAssignedIdentityProperties {
+    /** The id of the tenant which the identity belongs to. */
+    readonly tenantId?: string;
+    /** The id of the service principal object associated with the created identity. */
+    readonly principalId?: string;
+    /** The id of the app associated with the identity. This is a random generated UUID by MSI. */
+    readonly clientId?: string;
+    /** Enum to configure regional restrictions on identity assignment, as necessary. */
+    isolationScope?: IsolationScope;
+    /** Restrictions on which resource providers this identity can be assigned to. */
+    assignmentRestrictions?: AssignmentRestrictions;
+}
+export declare function userAssignedIdentityPropertiesSerializer(item: UserAssignedIdentityProperties): any;
+export declare function userAssignedIdentityPropertiesDeserializer(item: any): UserAssignedIdentityProperties;
+/** Enum to configure regional restrictions on identity assignment, as necessary. */
+export declare enum KnownIsolationScope {
+    /** None */
+    None = "None",
+    /** Regional */
+    Regional = "Regional"
+}
+/**
+ * Enum to configure regional restrictions on identity assignment, as necessary. \
+ * {@link KnownIsolationScope} can be used interchangeably with IsolationScope,
+ *  this enum contains the known values that the service supports.
+ * ### Known values supported by the service
+ * **None** \
+ * **Regional**
+ */
+export type IsolationScope = string;
+/** Configuration to restrict identity assignment to specific resource providers or resource types. */
+export interface AssignmentRestrictions {
+    /** List of resource providers or resource providers with resource types that this identity can be assigned to (case-insensitive). Examples: 'Microsoft.Compute', 'Microsoft.Storage/Accounts', 'Microsoft.Network/VirtualNetworks'. */
+    providers?: string[];
+}
+export declare function assignmentRestrictionsSerializer(item: AssignmentRestrictions): any;
+export declare function assignmentRestrictionsDeserializer(item: any): AssignmentRestrictions;
+/** The resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a 'location' */
+export interface TrackedResource extends Resource {
+    /** Resource tags. */
+    tags?: Record<string, string>;
+    /** The geo-location where the resource lives */
+    location: string;
+}
+export declare function trackedResourceSerializer(item: TrackedResource): any;
+export declare function trackedResourceDeserializer(item: any): TrackedResource;
+/** Describes an identity resource. */
+export interface IdentityUpdate extends Resource {
+    /** The geo-location where the resource lives */
+    location?: string;
+    /** Resource tags */
+    tags?: Record<string, string>;
+    /** The id of the tenant which the identity belongs to. */
+    readonly tenantId?: string;
+    /** The id of the service principal object associated with the created identity. */
+    readonly principalId?: string;
+    /** The id of the app associated with the identity. This is a random generated UUID by MSI. */
+    readonly clientId?: string;
+    /** Enum to configure regional restrictions on identity assignment, as necessary. */
+    isolationScope?: IsolationScope;
+    /** Restrictions on which resource providers this identity can be assigned to. */
+    assignmentRestrictions?: AssignmentRestrictions;
+}
+export declare function identityUpdateSerializer(item: IdentityUpdate): any;
+/** Values returned by the List operation. */
+export interface _UserAssignedIdentitiesListResult {
+    /** The Identity items on this page */
+    value: Identity[];
+    /** The link to the next page of items */
+    nextLink?: string;
+}
+export declare function _userAssignedIdentitiesListResultDeserializer(item: any): _UserAssignedIdentitiesListResult;
+export declare function identityArraySerializer(result: Array<Identity>): any[];
+export declare function identityArrayDeserializer(result: Array<Identity>): any[];
+/** The available API versions. */
+export declare enum KnownVersions {
+    /** The 2024-11-30 API version. */
+    V20241130 = "2024-11-30",
+    /** The 2025-05-31-preview API version. */
+    V20250531Preview = "2025-05-31-preview"
+}
+export declare function _systemAssignedIdentityPropertiesDeserializer(item: any): {
+    tenantId: any;
+    principalId: any;
+    clientId: any;
+    clientSecretUrl: any;
+};
+export declare function _federatedIdentityCredentialPropertiesSerializer(item: FederatedIdentityCredential): any;
+export declare function _federatedIdentityCredentialPropertiesDeserializer(item: any): {
+    issuer: any;
+    subject: any;
+    audiences: any;
+    claimsMatchingExpression: any;
+};
+export declare function _identityPropertiesSerializer(item: Identity): any;
+export declare function _identityPropertiesDeserializer(item: any): {
+    tenantId: any;
+    principalId: any;
+    clientId: any;
+    isolationScope: any;
+    assignmentRestrictions: any;
+};
+export declare function _identityUpdatePropertiesSerializer(item: IdentityUpdate): any;
+export declare function _identityUpdatePropertiesDeserializer(item: any): {
+    tenantId: any;
+    principalId: any;
+    clientId: any;
+    isolationScope: any;
+    assignmentRestrictions: any;
+};
+//# sourceMappingURL=models.d.ts.map