@azure/arm-containerregistry 10.1.1-alpha.20230918.1 → 11.0.0-alpha.20230919.1

package/types/arm-containerregistry.d.ts

@@ -247,6 +247,21 @@ export declare interface Argument {
     isSecret?: boolean;
 }
 
+/** Authentication credential stored for an upstream. */
+export declare interface AuthCredential {
+    /** The name of the credential. */
+    name?: CredentialName;
+    /** KeyVault Secret URI for accessing the username. */
+    usernameSecretIdentifier?: string;
+    /** KeyVault Secret URI for accessing the password. */
+    passwordSecretIdentifier?: string;
+    /**
+     * This provides data pertaining to the health of the auth credential.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly credentialHealth?: CredentialHealth;
+}
+
 /** The authorization properties for accessing the source code repository. */
 export declare interface AuthInfo {
     /** The type of Auth token. */
@@ -337,6 +352,183 @@ export declare interface BaseImageTriggerUpdateParameters {
     name: string;
 }
 
+/** An object that represents a cache rule for a container registry. */
+export declare interface CacheRule extends ProxyResource {
+    /** The ARM resource ID of the credential store which is associated with the cache rule. */
+    credentialSetResourceId?: string;
+    /** Source repository pulled from upstream. */
+    sourceRepository?: string;
+    /**
+     * Target repository specified in docker pull command.
+     * Eg: docker pull myregistry.azurecr.io/{targetRepository}:{tag}
+     */
+    targetRepository?: string;
+    /**
+     * The creation date of the cache rule.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly creationDate?: Date;
+    /**
+     * Provisioning state of the resource.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly provisioningState?: ProvisioningState;
+}
+
+/** Interface representing a CacheRules. */
+export declare interface CacheRules {
+    /**
+     * Lists all cache rule resources for the specified container registry.
+     * @param resourceGroupName The name of the resource group. The name is case insensitive.
+     * @param registryName The name of the container registry.
+     * @param options The options parameters.
+     */
+    list(resourceGroupName: string, registryName: string, options?: CacheRulesListOptionalParams): PagedAsyncIterableIterator<CacheRule>;
+    /**
+     * Gets the properties of the specified cache rule resource.
+     * @param resourceGroupName The name of the resource group. The name is case insensitive.
+     * @param registryName The name of the container registry.
+     * @param cacheRuleName The name of the cache rule.
+     * @param options The options parameters.
+     */
+    get(resourceGroupName: string, registryName: string, cacheRuleName: string, options?: CacheRulesGetOptionalParams): Promise<CacheRulesGetResponse>;
+    /**
+     * Creates a cache rule for a container registry with the specified parameters.
+     * @param resourceGroupName The name of the resource group. The name is case insensitive.
+     * @param registryName The name of the container registry.
+     * @param cacheRuleName The name of the cache rule.
+     * @param cacheRuleCreateParameters The parameters for creating a cache rule.
+     * @param options The options parameters.
+     */
+    beginCreate(resourceGroupName: string, registryName: string, cacheRuleName: string, cacheRuleCreateParameters: CacheRule, options?: CacheRulesCreateOptionalParams): Promise<SimplePollerLike<OperationState<CacheRulesCreateResponse>, CacheRulesCreateResponse>>;
+    /**
+     * Creates a cache rule for a container registry with the specified parameters.
+     * @param resourceGroupName The name of the resource group. The name is case insensitive.
+     * @param registryName The name of the container registry.
+     * @param cacheRuleName The name of the cache rule.
+     * @param cacheRuleCreateParameters The parameters for creating a cache rule.
+     * @param options The options parameters.
+     */
+    beginCreateAndWait(resourceGroupName: string, registryName: string, cacheRuleName: string, cacheRuleCreateParameters: CacheRule, options?: CacheRulesCreateOptionalParams): Promise<CacheRulesCreateResponse>;
+    /**
+     * Deletes a cache rule resource from a container registry.
+     * @param resourceGroupName The name of the resource group. The name is case insensitive.
+     * @param registryName The name of the container registry.
+     * @param cacheRuleName The name of the cache rule.
+     * @param options The options parameters.
+     */
+    beginDelete(resourceGroupName: string, registryName: string, cacheRuleName: string, options?: CacheRulesDeleteOptionalParams): Promise<SimplePollerLike<OperationState<CacheRulesDeleteResponse>, CacheRulesDeleteResponse>>;
+    /**
+     * Deletes a cache rule resource from a container registry.
+     * @param resourceGroupName The name of the resource group. The name is case insensitive.
+     * @param registryName The name of the container registry.
+     * @param cacheRuleName The name of the cache rule.
+     * @param options The options parameters.
+     */
+    beginDeleteAndWait(resourceGroupName: string, registryName: string, cacheRuleName: string, options?: CacheRulesDeleteOptionalParams): Promise<CacheRulesDeleteResponse>;
+    /**
+     * Updates a cache rule for a container registry with the specified parameters.
+     * @param resourceGroupName The name of the resource group. The name is case insensitive.
+     * @param registryName The name of the container registry.
+     * @param cacheRuleName The name of the cache rule.
+     * @param cacheRuleUpdateParameters The parameters for updating a cache rule.
+     * @param options The options parameters.
+     */
+    beginUpdate(resourceGroupName: string, registryName: string, cacheRuleName: string, cacheRuleUpdateParameters: CacheRuleUpdateParameters, options?: CacheRulesUpdateOptionalParams): Promise<SimplePollerLike<OperationState<CacheRulesUpdateResponse>, CacheRulesUpdateResponse>>;
+    /**
+     * Updates a cache rule for a container registry with the specified parameters.
+     * @param resourceGroupName The name of the resource group. The name is case insensitive.
+     * @param registryName The name of the container registry.
+     * @param cacheRuleName The name of the cache rule.
+     * @param cacheRuleUpdateParameters The parameters for updating a cache rule.
+     * @param options The options parameters.
+     */
+    beginUpdateAndWait(resourceGroupName: string, registryName: string, cacheRuleName: string, cacheRuleUpdateParameters: CacheRuleUpdateParameters, options?: CacheRulesUpdateOptionalParams): Promise<CacheRulesUpdateResponse>;
+}
+
+/** Defines headers for CacheRules_create operation. */
+export declare interface CacheRulesCreateHeaders {
+    azureAsyncOperation?: string;
+}
+
+/** Optional parameters. */
+export declare interface CacheRulesCreateOptionalParams extends coreClient.OperationOptions {
+    /** Delay to wait until next poll, in milliseconds. */
+    updateIntervalInMs?: number;
+    /** A serialized poller which can be used to resume an existing paused Long-Running-Operation. */
+    resumeFrom?: string;
+}
+
+/** Contains response data for the create operation. */
+export declare type CacheRulesCreateResponse = CacheRule;
+
+/** Defines headers for CacheRules_delete operation. */
+export declare interface CacheRulesDeleteHeaders {
+    location?: string;
+}
+
+/** Optional parameters. */
+export declare interface CacheRulesDeleteOptionalParams extends coreClient.OperationOptions {
+    /** Delay to wait until next poll, in milliseconds. */
+    updateIntervalInMs?: number;
+    /** A serialized poller which can be used to resume an existing paused Long-Running-Operation. */
+    resumeFrom?: string;
+}
+
+/** Contains response data for the delete operation. */
+export declare type CacheRulesDeleteResponse = CacheRulesDeleteHeaders;
+
+/** Optional parameters. */
+export declare interface CacheRulesGetOptionalParams extends coreClient.OperationOptions {
+}
+
+/** Contains response data for the get operation. */
+export declare type CacheRulesGetResponse = CacheRule;
+
+/** Optional parameters. */
+export declare interface CacheRulesListNextOptionalParams extends coreClient.OperationOptions {
+}
+
+/** Contains response data for the listNext operation. */
+export declare type CacheRulesListNextResponse = CacheRulesListResult;
+
+/** Optional parameters. */
+export declare interface CacheRulesListOptionalParams extends coreClient.OperationOptions {
+}
+
+/** Contains response data for the list operation. */
+export declare type CacheRulesListResponse = CacheRulesListResult;
+
+/** The result of a request to list cache rules for a container registry. */
+export declare interface CacheRulesListResult {
+    /** The list of cache rules. */
+    value?: CacheRule[];
+    /** If provided, client must use NextLink URI to request next list of cache rules. */
+    nextLink?: string;
+}
+
+/** Defines headers for CacheRules_update operation. */
+export declare interface CacheRulesUpdateHeaders {
+    azureAsyncOperation?: string;
+}
+
+/** Optional parameters. */
+export declare interface CacheRulesUpdateOptionalParams extends coreClient.OperationOptions {
+    /** Delay to wait until next poll, in milliseconds. */
+    updateIntervalInMs?: number;
+    /** A serialized poller which can be used to resume an existing paused Long-Running-Operation. */
+    resumeFrom?: string;
+}
+
+/** Contains response data for the update operation. */
+export declare type CacheRulesUpdateResponse = CacheRule;
+
+/** The parameters for updating a cache rule. */
+export declare interface CacheRuleUpdateParameters {
+    /** The ARM resource ID of the credential store which is associated with the Cache rule. */
+    credentialSetResourceId?: string;
+}
+
 /** The configuration of service URI and custom headers for the webhook. */
 export declare interface CallbackConfig {
     /** The service URI for the webhook to post notifications. */
@@ -369,6 +561,8 @@ export declare class ContainerRegistryManagementClient extends coreClient.Servic
      * @param options The parameter options
      */
     constructor(credentials: coreAuth.TokenCredential, subscriptionId: string, options?: ContainerRegistryManagementClientOptionalParams);
+    cacheRules: CacheRules;
+    credentialSets: CredentialSets;
     registries: Registries;
     operations: Operations;
     privateEndpointConnections: PrivateEndpointConnections;
@@ -402,6 +596,35 @@ export declare interface ContainerRegistryManagementClientOptionalParams extends
  */
 export declare type CreatedByType = string;
 
+/** The health of the auth credential. */
+export declare interface CredentialHealth {
+    /** The health status of credential. */
+    status?: CredentialHealthStatus;
+    /** Error code representing the health check error. */
+    errorCode?: string;
+    /** Descriptive message representing the health check error. */
+    errorMessage?: string;
+}
+
+/**
+ * Defines values for CredentialHealthStatus. \
+ * {@link KnownCredentialHealthStatus} can be used interchangeably with CredentialHealthStatus,
+ *  this enum contains the known values that the service supports.
+ * ### Known values supported by the service
+ * **Healthy** \
+ * **Unhealthy**
+ */
+export declare type CredentialHealthStatus = string;
+
+/**
+ * Defines values for CredentialName. \
+ * {@link KnownCredentialName} can be used interchangeably with CredentialName,
+ *  this enum contains the known values that the service supports.
+ * ### Known values supported by the service
+ * **Credential1**
+ */
+export declare type CredentialName = string;
+
 /** The parameters that describes a set of credentials that will be used when a run is invoked. */
 export declare interface Credentials {
     /** Describes the credential parameters for accessing the source registry. */
@@ -416,6 +639,188 @@ export declare interface Credentials {
     };
 }
 
+/** An object that represents a credential set resource for a container registry. */
+export declare interface CredentialSet extends ProxyResource {
+    /** Identities associated with the resource. This is used to access the KeyVault secrets. */
+    identity?: IdentityProperties;
+    /** The credentials are stored for this upstream or login server. */
+    loginServer?: string;
+    /**
+     * List of authentication credentials stored for an upstream.
+     * Usually consists of a primary and an optional secondary credential.
+     */
+    authCredentials?: AuthCredential[];
+    /**
+     * The creation date of credential store resource.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly creationDate?: Date;
+    /**
+     * Provisioning state of the resource.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly provisioningState?: ProvisioningState;
+}
+
+/** The result of a request to list credential sets for a container registry. */
+export declare interface CredentialSetListResult {
+    /** The list of credential sets. Since this list may be incomplete, the nextLink field should be used to request the next list of credential sets. */
+    value?: CredentialSet[];
+    /** The URI that can be used to request the next list of credential sets. */
+    nextLink?: string;
+}
+
+/** Interface representing a CredentialSets. */
+export declare interface CredentialSets {
+    /**
+     * Lists all credential set resources for the specified container registry.
+     * @param resourceGroupName The name of the resource group. The name is case insensitive.
+     * @param registryName The name of the container registry.
+     * @param options The options parameters.
+     */
+    list(resourceGroupName: string, registryName: string, options?: CredentialSetsListOptionalParams): PagedAsyncIterableIterator<CredentialSet>;
+    /**
+     * Gets the properties of the specified credential set resource.
+     * @param resourceGroupName The name of the resource group. The name is case insensitive.
+     * @param registryName The name of the container registry.
+     * @param credentialSetName The name of the credential set.
+     * @param options The options parameters.
+     */
+    get(resourceGroupName: string, registryName: string, credentialSetName: string, options?: CredentialSetsGetOptionalParams): Promise<CredentialSetsGetResponse>;
+    /**
+     * Creates a credential set for a container registry with the specified parameters.
+     * @param resourceGroupName The name of the resource group. The name is case insensitive.
+     * @param registryName The name of the container registry.
+     * @param credentialSetName The name of the credential set.
+     * @param credentialSetCreateParameters The parameters for creating a credential set.
+     * @param options The options parameters.
+     */
+    beginCreate(resourceGroupName: string, registryName: string, credentialSetName: string, credentialSetCreateParameters: CredentialSet, options?: CredentialSetsCreateOptionalParams): Promise<SimplePollerLike<OperationState<CredentialSetsCreateResponse>, CredentialSetsCreateResponse>>;
+    /**
+     * Creates a credential set for a container registry with the specified parameters.
+     * @param resourceGroupName The name of the resource group. The name is case insensitive.
+     * @param registryName The name of the container registry.
+     * @param credentialSetName The name of the credential set.
+     * @param credentialSetCreateParameters The parameters for creating a credential set.
+     * @param options The options parameters.
+     */
+    beginCreateAndWait(resourceGroupName: string, registryName: string, credentialSetName: string, credentialSetCreateParameters: CredentialSet, options?: CredentialSetsCreateOptionalParams): Promise<CredentialSetsCreateResponse>;
+    /**
+     * Deletes a credential set from a container registry.
+     * @param resourceGroupName The name of the resource group. The name is case insensitive.
+     * @param registryName The name of the container registry.
+     * @param credentialSetName The name of the credential set.
+     * @param options The options parameters.
+     */
+    beginDelete(resourceGroupName: string, registryName: string, credentialSetName: string, options?: CredentialSetsDeleteOptionalParams): Promise<SimplePollerLike<OperationState<CredentialSetsDeleteResponse>, CredentialSetsDeleteResponse>>;
+    /**
+     * Deletes a credential set from a container registry.
+     * @param resourceGroupName The name of the resource group. The name is case insensitive.
+     * @param registryName The name of the container registry.
+     * @param credentialSetName The name of the credential set.
+     * @param options The options parameters.
+     */
+    beginDeleteAndWait(resourceGroupName: string, registryName: string, credentialSetName: string, options?: CredentialSetsDeleteOptionalParams): Promise<CredentialSetsDeleteResponse>;
+    /**
+     * Updates a credential set for a container registry with the specified parameters.
+     * @param resourceGroupName The name of the resource group. The name is case insensitive.
+     * @param registryName The name of the container registry.
+     * @param credentialSetName The name of the credential set.
+     * @param credentialSetUpdateParameters The parameters for updating a credential set.
+     * @param options The options parameters.
+     */
+    beginUpdate(resourceGroupName: string, registryName: string, credentialSetName: string, credentialSetUpdateParameters: CredentialSetUpdateParameters, options?: CredentialSetsUpdateOptionalParams): Promise<SimplePollerLike<OperationState<CredentialSetsUpdateResponse>, CredentialSetsUpdateResponse>>;
+    /**
+     * Updates a credential set for a container registry with the specified parameters.
+     * @param resourceGroupName The name of the resource group. The name is case insensitive.
+     * @param registryName The name of the container registry.
+     * @param credentialSetName The name of the credential set.
+     * @param credentialSetUpdateParameters The parameters for updating a credential set.
+     * @param options The options parameters.
+     */
+    beginUpdateAndWait(resourceGroupName: string, registryName: string, credentialSetName: string, credentialSetUpdateParameters: CredentialSetUpdateParameters, options?: CredentialSetsUpdateOptionalParams): Promise<CredentialSetsUpdateResponse>;
+}
+
+/** Defines headers for CredentialSets_create operation. */
+export declare interface CredentialSetsCreateHeaders {
+    azureAsyncOperation?: string;
+}
+
+/** Optional parameters. */
+export declare interface CredentialSetsCreateOptionalParams extends coreClient.OperationOptions {
+    /** Delay to wait until next poll, in milliseconds. */
+    updateIntervalInMs?: number;
+    /** A serialized poller which can be used to resume an existing paused Long-Running-Operation. */
+    resumeFrom?: string;
+}
+
+/** Contains response data for the create operation. */
+export declare type CredentialSetsCreateResponse = CredentialSet;
+
+/** Defines headers for CredentialSets_delete operation. */
+export declare interface CredentialSetsDeleteHeaders {
+    location?: string;
+}
+
+/** Optional parameters. */
+export declare interface CredentialSetsDeleteOptionalParams extends coreClient.OperationOptions {
+    /** Delay to wait until next poll, in milliseconds. */
+    updateIntervalInMs?: number;
+    /** A serialized poller which can be used to resume an existing paused Long-Running-Operation. */
+    resumeFrom?: string;
+}
+
+/** Contains response data for the delete operation. */
+export declare type CredentialSetsDeleteResponse = CredentialSetsDeleteHeaders;
+
+/** Optional parameters. */
+export declare interface CredentialSetsGetOptionalParams extends coreClient.OperationOptions {
+}
+
+/** Contains response data for the get operation. */
+export declare type CredentialSetsGetResponse = CredentialSet;
+
+/** Optional parameters. */
+export declare interface CredentialSetsListNextOptionalParams extends coreClient.OperationOptions {
+}
+
+/** Contains response data for the listNext operation. */
+export declare type CredentialSetsListNextResponse = CredentialSetListResult;
+
+/** Optional parameters. */
+export declare interface CredentialSetsListOptionalParams extends coreClient.OperationOptions {
+}
+
+/** Contains response data for the list operation. */
+export declare type CredentialSetsListResponse = CredentialSetListResult;
+
+/** Defines headers for CredentialSets_update operation. */
+export declare interface CredentialSetsUpdateHeaders {
+    azureAsyncOperation?: string;
+}
+
+/** Optional parameters. */
+export declare interface CredentialSetsUpdateOptionalParams extends coreClient.OperationOptions {
+    /** Delay to wait until next poll, in milliseconds. */
+    updateIntervalInMs?: number;
+    /** A serialized poller which can be used to resume an existing paused Long-Running-Operation. */
+    resumeFrom?: string;
+}
+
+/** Contains response data for the update operation. */
+export declare type CredentialSetsUpdateResponse = CredentialSet;
+
+/** The parameters for updating a credential set */
+export declare interface CredentialSetUpdateParameters {
+    /** Identities associated with the resource. This is used to access the KeyVault secrets. */
+    identity?: IdentityProperties;
+    /**
+     * List of authentication credentials stored for an upstream.
+     * Usually consists of a primary and an optional secondary credential.
+     */
+    authCredentials?: AuthCredential[];
+}
+
 /** Describes the credentials that will be used to access a custom registry during a run. */
 export declare interface CustomRegistryCredentials {
     /** The username for logging into the custom registry. */
@@ -578,10 +983,53 @@ export declare interface EncryptionProperty {
  */
 export declare type EncryptionStatus = string;
 
-/** An error response from the Azure Container Registry service. */
+/** The resource management error additional info. */
+export declare interface ErrorAdditionalInfo {
+    /**
+     * The additional info type.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly type?: string;
+    /**
+     * The additional info.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly info?: Record<string, unknown>;
+}
+
+/** The error detail. */
+export declare interface ErrorDetail {
+    /**
+     * The error code.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly code?: string;
+    /**
+     * The error message.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly message?: string;
+    /**
+     * The error target.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly target?: string;
+    /**
+     * The error details.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly details?: ErrorDetail[];
+    /**
+     * The error additional info.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly additionalInfo?: ErrorAdditionalInfo[];
+}
+
+/** Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.). */
 export declare interface ErrorResponse {
-    /** Azure container registry build API error body. */
-    error?: ErrorResponseBody;
+    /** The error object. */
+    error?: ErrorDetail;
 }
 
 /** An error response from the Azure Container Registry service. */
@@ -596,6 +1044,12 @@ export declare interface ErrorResponseBody {
     details?: InnerErrorDescription[];
 }
 
+/** An error response from the Azure Container Registry service. */
+export declare interface ErrorResponseForContainerRegistry {
+    /** Azure container registry build API error body. */
+    error?: ErrorResponseBody;
+}
+
 /** The event for a webhook. */
 declare interface Event_2 extends EventInfo {
     /** The event request message sent to the service URI. */
@@ -763,10 +1217,16 @@ export declare function getContinuationToken(page: unknown): string | undefined;
 
 /** Managed identity for the resource. */
 export declare interface IdentityProperties {
-    /** The principal ID of resource identity. */
-    principalId?: string;
-    /** The tenant ID of resource. */
-    tenantId?: string;
+    /**
+     * The principal ID of resource identity.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly principalId?: string;
+    /**
+     * The tenant ID of resource.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly tenantId?: string;
     /** The identity type. */
     type?: ResourceIdentityType;
     /**
@@ -954,6 +1414,20 @@ export declare enum KnownCreatedByType {
     Key = "Key"
 }
 
+/** Known values of {@link CredentialHealthStatus} that the service accepts. */
+export declare enum KnownCredentialHealthStatus {
+    /** Healthy */
+    Healthy = "Healthy",
+    /** Unhealthy */
+    Unhealthy = "Unhealthy"
+}
+
+/** Known values of {@link CredentialName} that the service accepts. */
+export declare enum KnownCredentialName {
+    /** Credential1 */
+    Credential1 = "Credential1"
+}
+
 /** Known values of {@link DefaultAction} that the service accepts. */
 export declare enum KnownDefaultAction {
     /** Allow */
@@ -3907,10 +4381,16 @@ export declare type TrustPolicyType = string;
 export declare type UpdateTriggerPayloadType = string;
 
 export declare interface UserIdentityProperties {
-    /** The principal id of user assigned identity. */
-    principalId?: string;
-    /** The client id of user assigned identity. */
-    clientId?: string;
+    /**
+     * The principal id of user assigned identity.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly principalId?: string;
+    /**
+     * The client id of user assigned identity.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly clientId?: string;
 }
 
 /**

package/types/tsdoc-metadata.json

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