{ "swagger": "2.0", "info": { "title": "ContainerRegistryManagementClient", "version": "2025-11-01", "description": "The Microsoft Azure Container Registry management API provides create, read, update, and delete functionality for Azure Container Registry resources including registries, replications, webhooks, tasks, runs, and other registry components.", "x-typespec-generated": [ { "emitter": "@azure-tools/typespec-autorest" } ] }, "schemes": [ "https" ], "host": "management.azure.com", "produces": [ "application/json" ], "consumes": [ "application/json" ], "security": [ { "azure_auth": [ "user_impersonation" ] } ], "securityDefinitions": { "azure_auth": { "type": "oauth2", "description": "Azure Active Directory OAuth2 Flow.", "flow": "implicit", "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", "scopes": { "user_impersonation": "impersonate your user account" } } }, "tags": [ { "name": "Operations" }, { "name": "Registries" }, { "name": "CacheRules" }, { "name": "CredentialSets" }, { "name": "ConnectedRegistries" }, { "name": "PrivateLinkResources" }, { "name": "PrivateEndpointConnections" }, { "name": "Replications" }, { "name": "ScopeMaps" }, { "name": "Tokens" }, { "name": "Webhooks" } ], "paths": { "/providers/Microsoft.ContainerRegistry/operations": { "get": { "operationId": "Operations_List", "tags": [ "Operations" ], "description": "List the operations for the provider", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/OperationListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "OperationList": { "$ref": "./examples/OperationList.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/providers/Microsoft.ContainerRegistry/checkNameAvailability": { "post": { "operationId": "Registries_CheckNameAvailability", "tags": [ "Registries" ], "description": "Checks whether the container registry name is available for use. The name must contain only alphanumeric characters, be globally unique, and between 5 and 50 characters in length.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "name": "registryNameCheckRequest", "in": "body", "description": "The request body", "required": true, "schema": { "$ref": "#/definitions/RegistryNameCheckRequest" } } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/RegistryNameStatus" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "RegistryCheckNameAvailable": { "$ref": "./examples/RegistryCheckNameAvailable.json" }, "RegistryCheckNameNotAvailable": { "$ref": "./examples/RegistryCheckNameNotAvailable.json" } } } }, "/subscriptions/{subscriptionId}/providers/Microsoft.ContainerRegistry/registries": { "get": { "operationId": "Registries_List", "tags": [ "Registries" ], "description": "Lists all the container registries under the specified subscription.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/RegistryListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "RegistryList": { "$ref": "./examples/RegistryList.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries": { "get": { "operationId": "Registries_ListByResourceGroup", "tags": [ "Registries" ], "description": "Lists all the container registries under the specified resource group.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/RegistryListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "RegistryListByResourceGroup": { "$ref": "./examples/RegistryListByResourceGroup.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}": { "get": { "operationId": "Registries_Get", "tags": [ "Registries" ], "description": "Gets the properties of the specified container registry.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "registryName", "in": "path", "description": "The name of the container registry.", "required": true, "type": "string", "minLength": 5, "maxLength": 50, "pattern": "^[a-zA-Z0-9]*$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/Registry" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "RegistryGet": { "$ref": "./examples/RegistryGet.json" } } }, "put": { "operationId": "Registries_Create", "tags": [ "Registries" ], "description": "Creates a container registry with the specified parameters.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "registryName", "in": "path", "description": "The name of the container registry.", "required": true, "type": "string", "minLength": 5, "maxLength": 50, "pattern": "^[a-zA-Z0-9]*$" }, { "name": "registry", "in": "body", "description": "The parameters for creating a container registry.", "required": true, "schema": { "$ref": "#/definitions/Registry" } } ], "responses": { "200": { "description": "Resource 'Registry' update operation succeeded", "schema": { "$ref": "#/definitions/Registry" } }, "201": { "description": "Resource 'Registry' create operation succeeded", "schema": { "$ref": "#/definitions/Registry" }, "headers": { "Azure-AsyncOperation": { "type": "string", "description": "A link to the status monitor" }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "RegistryCreate": { "$ref": "./examples/RegistryCreate.json" }, "RegistryCreateAbac": { "$ref": "./examples/RegistryCreateAbac.json" }, "RegistryCreateZoneRedundant": { "$ref": "./examples/RegistryCreateZoneRedundant.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "azure-async-operation", "final-state-schema": "#/definitions/Registry" }, "x-ms-long-running-operation": true }, "patch": { "operationId": "Registries_Update", "tags": [ "Registries" ], "description": "Updates a container registry with the specified parameters.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "registryName", "in": "path", "description": "The name of the container registry.", "required": true, "type": "string", "minLength": 5, "maxLength": 50, "pattern": "^[a-zA-Z0-9]*$" }, { "name": "registryUpdateParameters", "in": "body", "description": "The parameters for updating a container registry.", "required": true, "schema": { "$ref": "#/definitions/RegistryUpdateParameters" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/Registry" } }, "201": { "description": "Resource 'Registry' create operation succeeded", "schema": { "$ref": "#/definitions/Registry" }, "headers": { "Azure-AsyncOperation": { "type": "string", "description": "A link to the status monitor" }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "RegistryUpdate": { "$ref": "./examples/RegistryUpdate.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "azure-async-operation", "final-state-schema": "#/definitions/Registry" }, "x-ms-long-running-operation": true }, "delete": { "operationId": "Registries_Delete", "tags": [ "Registries" ], "description": "Deletes a container registry.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "registryName", "in": "path", "description": "The name of the container registry.", "required": true, "type": "string", "minLength": 5, "maxLength": 50, "pattern": "^[a-zA-Z0-9]*$" } ], "responses": { "200": { "description": "Resource deleted successfully." }, "202": { "description": "Resource deletion accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "204": { "description": "Resource does not exist." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "RegistryDelete": { "$ref": "./examples/RegistryDelete.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/cacheRules": { "get": { "operationId": "CacheRules_List", "tags": [ "CacheRules" ], "description": "Lists all cache rule resources for the specified container registry.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "registryName", "in": "path", "description": "The name of the container registry.", "required": true, "type": "string", "minLength": 5, "maxLength": 50, "pattern": "^[a-zA-Z0-9]*$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/CacheRulesListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "CacheRuleList": { "$ref": "./examples/CacheRuleList.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/cacheRules/{cacheRuleName}": { "get": { "operationId": "CacheRules_Get", "tags": [ "CacheRules" ], "description": "Gets the properties of the specified cache rule resource.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "registryName", "in": "path", "description": "The name of the container registry.", "required": true, "type": "string", "minLength": 5, "maxLength": 50, "pattern": "^[a-zA-Z0-9]*$" }, { "name": "cacheRuleName", "in": "path", "description": "The name of the cache rule.", "required": true, "type": "string", "minLength": 5, "maxLength": 50, "pattern": "^[a-zA-Z0-9-]*$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/CacheRule" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "CacheRuleGet": { "$ref": "./examples/CacheRuleGet.json" } } }, "put": { "operationId": "CacheRules_Create", "tags": [ "CacheRules" ], "description": "Creates a cache rule for a container registry with the specified parameters.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "registryName", "in": "path", "description": "The name of the container registry.", "required": true, "type": "string", "minLength": 5, "maxLength": 50, "pattern": "^[a-zA-Z0-9]*$" }, { "name": "cacheRuleName", "in": "path", "description": "The name of the cache rule.", "required": true, "type": "string", "minLength": 5, "maxLength": 50, "pattern": "^[a-zA-Z0-9-]*$" }, { "name": "cacheRuleCreateParameters", "in": "body", "description": "The parameters for creating a cache rule.", "required": true, "schema": { "$ref": "#/definitions/CacheRule" } } ], "responses": { "200": { "description": "Resource 'CacheRule' update operation succeeded", "schema": { "$ref": "#/definitions/CacheRule" } }, "201": { "description": "Resource 'CacheRule' create operation succeeded", "schema": { "$ref": "#/definitions/CacheRule" }, "headers": { "Azure-AsyncOperation": { "type": "string", "description": "A link to the status monitor" }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "CacheRuleCreate": { "$ref": "./examples/CacheRuleCreate.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "azure-async-operation", "final-state-schema": "#/definitions/CacheRule" }, "x-ms-long-running-operation": true }, "patch": { "operationId": "CacheRules_Update", "tags": [ "CacheRules" ], "description": "Updates a cache rule for a container registry with the specified parameters.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "registryName", "in": "path", "description": "The name of the container registry.", "required": true, "type": "string", "minLength": 5, "maxLength": 50, "pattern": "^[a-zA-Z0-9]*$" }, { "name": "cacheRuleName", "in": "path", "description": "The name of the cache rule.", "required": true, "type": "string", "minLength": 5, "maxLength": 50, "pattern": "^[a-zA-Z0-9-]*$" }, { "name": "cacheRuleUpdateParameters", "in": "body", "description": "The parameters for updating a cache rule.", "required": true, "schema": { "$ref": "#/definitions/CacheRuleUpdateParameters" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/CacheRule" } }, "201": { "description": "Resource 'CacheRule' create operation succeeded", "schema": { "$ref": "#/definitions/CacheRule" }, "headers": { "Azure-AsyncOperation": { "type": "string", "description": "A link to the status monitor" }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "CacheRuleUpdate": { "$ref": "./examples/CacheRuleUpdate.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "azure-async-operation", "final-state-schema": "#/definitions/CacheRule" }, "x-ms-long-running-operation": true }, "delete": { "operationId": "CacheRules_Delete", "tags": [ "CacheRules" ], "description": "Deletes a cache rule resource from a container registry.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "registryName", "in": "path", "description": "The name of the container registry.", "required": true, "type": "string", "minLength": 5, "maxLength": 50, "pattern": "^[a-zA-Z0-9]*$" }, { "name": "cacheRuleName", "in": "path", "description": "The name of the cache rule.", "required": true, "type": "string", "minLength": 5, "maxLength": 50, "pattern": "^[a-zA-Z0-9-]*$" } ], "responses": { "202": { "description": "Resource deletion accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "204": { "description": "Resource does not exist." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "CacheRuleDelete": { "$ref": "./examples/CacheRuleDelete.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/connectedRegistries": { "get": { "operationId": "ConnectedRegistries_List", "tags": [ "ConnectedRegistries" ], "description": "Lists all connected registries for the specified container registry.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "registryName", "in": "path", "description": "The name of the container registry.", "required": true, "type": "string", "minLength": 5, "maxLength": 50, "pattern": "^[a-zA-Z0-9]*$" }, { "name": "$filter", "in": "query", "description": "An OData filter expression that describes a subset of connectedRegistries to return. The parameters that can be filtered are parent.id (the resource id of the connectedRegistry parent), mode, and connectionState. The supported operator is eq.", "required": false, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ConnectedRegistryListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "ConnectedRegistryList": { "$ref": "./examples/ConnectedRegistryList.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/connectedRegistries/{connectedRegistryName}": { "get": { "operationId": "ConnectedRegistries_Get", "tags": [ "ConnectedRegistries" ], "description": "Gets the properties of the connected registry.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "registryName", "in": "path", "description": "The name of the container registry.", "required": true, "type": "string", "minLength": 5, "maxLength": 50, "pattern": "^[a-zA-Z0-9]*$" }, { "name": "connectedRegistryName", "in": "path", "description": "The name of the connected registry.", "required": true, "type": "string", "minLength": 5, "maxLength": 50, "pattern": "^[a-zA-Z0-9]*$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ConnectedRegistry" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "ConnectedRegistryGet": { "$ref": "./examples/ConnectedRegistryGet.json" } } }, "put": { "operationId": "ConnectedRegistries_Create", "tags": [ "ConnectedRegistries" ], "description": "Creates a connected registry for a container registry with the specified parameters.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "registryName", "in": "path", "description": "The name of the container registry.", "required": true, "type": "string", "minLength": 5, "maxLength": 50, "pattern": "^[a-zA-Z0-9]*$" }, { "name": "connectedRegistryName", "in": "path", "description": "The name of the connected registry.", "required": true, "type": "string", "minLength": 5, "maxLength": 50, "pattern": "^[a-zA-Z0-9]*$" }, { "name": "connectedRegistryCreateParameters", "in": "body", "description": "The parameters for creating a connectedRegistry.", "required": true, "schema": { "$ref": "#/definitions/ConnectedRegistry" } } ], "responses": { "200": { "description": "Resource 'ConnectedRegistry' update operation succeeded", "schema": { "$ref": "#/definitions/ConnectedRegistry" } }, "201": { "description": "Resource 'ConnectedRegistry' create operation succeeded", "schema": { "$ref": "#/definitions/ConnectedRegistry" }, "headers": { "Azure-AsyncOperation": { "type": "string", "description": "A link to the status monitor" }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "ConnectedRegistryCreate": { "$ref": "./examples/ConnectedRegistryCreate.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "azure-async-operation", "final-state-schema": "#/definitions/ConnectedRegistry" }, "x-ms-long-running-operation": true }, "patch": { "operationId": "ConnectedRegistries_Update", "tags": [ "ConnectedRegistries" ], "description": "Updates a connected registry with the specified parameters.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "registryName", "in": "path", "description": "The name of the container registry.", "required": true, "type": "string", "minLength": 5, "maxLength": 50, "pattern": "^[a-zA-Z0-9]*$" }, { "name": "connectedRegistryName", "in": "path", "description": "The name of the connected registry.", "required": true, "type": "string", "minLength": 5, "maxLength": 50, "pattern": "^[a-zA-Z0-9]*$" }, { "name": "connectedRegistryUpdateParameters", "in": "body", "description": "The parameters for updating a connectedRegistry.", "required": true, "schema": { "$ref": "#/definitions/ConnectedRegistryUpdateParameters" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ConnectedRegistry" } }, "201": { "description": "Resource 'ConnectedRegistry' create operation succeeded", "schema": { "$ref": "#/definitions/ConnectedRegistry" }, "headers": { "Azure-AsyncOperation": { "type": "string", "description": "A link to the status monitor" }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "ConnectedRegistryUpdate": { "$ref": "./examples/ConnectedRegistryUpdate.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "azure-async-operation", "final-state-schema": "#/definitions/ConnectedRegistry" }, "x-ms-long-running-operation": true }, "delete": { "operationId": "ConnectedRegistries_Delete", "tags": [ "ConnectedRegistries" ], "description": "Deletes a connected registry from a container registry.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "registryName", "in": "path", "description": "The name of the container registry.", "required": true, "type": "string", "minLength": 5, "maxLength": 50, "pattern": "^[a-zA-Z0-9]*$" }, { "name": "connectedRegistryName", "in": "path", "description": "The name of the connected registry.", "required": true, "type": "string", "minLength": 5, "maxLength": 50, "pattern": "^[a-zA-Z0-9]*$" } ], "responses": { "200": { "description": "Resource deleted successfully." }, "202": { "description": "Resource deletion accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "204": { "description": "Resource does not exist." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "ConnectedRegistryDelete": { "$ref": "./examples/ConnectedRegistryDelete.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/connectedRegistries/{connectedRegistryName}/deactivate": { "post": { "operationId": "ConnectedRegistries_Deactivate", "tags": [ "ConnectedRegistries" ], "description": "Deactivates the connected registry instance.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "registryName", "in": "path", "description": "The name of the container registry.", "required": true, "type": "string", "minLength": 5, "maxLength": 50, "pattern": "^[a-zA-Z0-9]*$" }, { "name": "connectedRegistryName", "in": "path", "description": "The name of the connected registry.", "required": true, "type": "string", "minLength": 5, "maxLength": 50, "pattern": "^[a-zA-Z0-9]*$" } ], "responses": { "200": { "description": "Azure operation completed successfully." }, "202": { "description": "Resource operation accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "ConnectedRegistryDeactivate": { "$ref": "./examples/ConnectedRegistryDeactivate.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/credentialSets": { "get": { "operationId": "CredentialSets_List", "tags": [ "CredentialSets" ], "description": "Lists all credential set resources for the specified container registry.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "registryName", "in": "path", "description": "The name of the container registry.", "required": true, "type": "string", "minLength": 5, "maxLength": 50, "pattern": "^[a-zA-Z0-9]*$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/CredentialSetListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "CredentialSetList": { "$ref": "./examples/CredentialSetList.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/credentialSets/{credentialSetName}": { "get": { "operationId": "CredentialSets_Get", "tags": [ "CredentialSets" ], "description": "Gets the properties of the specified credential set resource.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "registryName", "in": "path", "description": "The name of the container registry.", "required": true, "type": "string", "minLength": 5, "maxLength": 50, "pattern": "^[a-zA-Z0-9]*$" }, { "name": "credentialSetName", "in": "path", "description": "The name of the credential set.", "required": true, "type": "string", "minLength": 5, "maxLength": 50, "pattern": "^[a-zA-Z0-9-]*$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/CredentialSet" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "CredentialSetGet": { "$ref": "./examples/CredentialSetGet.json" } } }, "put": { "operationId": "CredentialSets_Create", "tags": [ "CredentialSets" ], "description": "Creates a credential set for a container registry with the specified parameters.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "registryName", "in": "path", "description": "The name of the container registry.", "required": true, "type": "string", "minLength": 5, "maxLength": 50, "pattern": "^[a-zA-Z0-9]*$" }, { "name": "credentialSetName", "in": "path", "description": "The name of the credential set.", "required": true, "type": "string", "minLength": 5, "maxLength": 50, "pattern": "^[a-zA-Z0-9-]*$" }, { "name": "credentialSetCreateParameters", "in": "body", "description": "The parameters for creating a credential set.", "required": true, "schema": { "$ref": "#/definitions/CredentialSet" } } ], "responses": { "200": { "description": "Resource 'CredentialSet' update operation succeeded", "schema": { "$ref": "#/definitions/CredentialSet" } }, "201": { "description": "Resource 'CredentialSet' create operation succeeded", "schema": { "$ref": "#/definitions/CredentialSet" }, "headers": { "Azure-AsyncOperation": { "type": "string", "description": "A link to the status monitor" }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "CredentialSetCreate": { "$ref": "./examples/CredentialSetCreate.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "azure-async-operation", "final-state-schema": "#/definitions/CredentialSet" }, "x-ms-long-running-operation": true }, "patch": { "operationId": "CredentialSets_Update", "tags": [ "CredentialSets" ], "description": "Updates a credential set for a container registry with the specified parameters.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "registryName", "in": "path", "description": "The name of the container registry.", "required": true, "type": "string", "minLength": 5, "maxLength": 50, "pattern": "^[a-zA-Z0-9]*$" }, { "name": "credentialSetName", "in": "path", "description": "The name of the credential set.", "required": true, "type": "string", "minLength": 5, "maxLength": 50, "pattern": "^[a-zA-Z0-9-]*$" }, { "name": "credentialSetUpdateParameters", "in": "body", "description": "The parameters for updating a credential set.", "required": true, "schema": { "$ref": "#/definitions/CredentialSetUpdateParameters" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/CredentialSet" } }, "201": { "description": "Resource 'CredentialSet' create operation succeeded", "schema": { "$ref": "#/definitions/CredentialSet" }, "headers": { "Azure-AsyncOperation": { "type": "string", "description": "A link to the status monitor" }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "CredentialSetUpdate": { "$ref": "./examples/CredentialSetUpdate.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "azure-async-operation", "final-state-schema": "#/definitions/CredentialSet" }, "x-ms-long-running-operation": true }, "delete": { "operationId": "CredentialSets_Delete", "tags": [ "CredentialSets" ], "description": "Deletes a credential set from a container registry.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "registryName", "in": "path", "description": "The name of the container registry.", "required": true, "type": "string", "minLength": 5, "maxLength": 50, "pattern": "^[a-zA-Z0-9]*$" }, { "name": "credentialSetName", "in": "path", "description": "The name of the credential set.", "required": true, "type": "string", "minLength": 5, "maxLength": 50, "pattern": "^[a-zA-Z0-9-]*$" } ], "responses": { "202": { "description": "Resource deletion accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "204": { "description": "Resource does not exist." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "CredentialSetDelete": { "$ref": "./examples/CredentialSetDelete.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/generateCredentials": { "post": { "operationId": "Registries_GenerateCredentials", "tags": [ "Registries" ], "description": "Generate keys for a token of a specified container registry.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "registryName", "in": "path", "description": "The name of the container registry.", "required": true, "type": "string", "minLength": 5, "maxLength": 50, "pattern": "^[a-zA-Z0-9]*$" }, { "name": "generateCredentialsParameters", "in": "body", "description": "The parameters for generating credentials.", "required": true, "schema": { "$ref": "#/definitions/GenerateCredentialsParameters" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/GenerateCredentialsResult" } }, "202": { "description": "Resource operation accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "RegistryGenerateCredentials": { "$ref": "./examples/RegistryGenerateCredentials.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location", "final-state-schema": "#/definitions/GenerateCredentialsResult" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/importImage": { "post": { "operationId": "Registries_ImportImage", "tags": [ "Registries" ], "description": "Copies an image to this container registry from the specified container registry.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "registryName", "in": "path", "description": "The name of the container registry.", "required": true, "type": "string", "minLength": 5, "maxLength": 50, "pattern": "^[a-zA-Z0-9]*$" }, { "name": "parameters", "in": "body", "description": "The parameters specifying the image to copy and the source container registry.", "required": true, "schema": { "$ref": "#/definitions/ImportImageParameters" } } ], "responses": { "200": { "description": "Azure operation completed successfully." }, "202": { "description": "Resource operation accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "ImportImageByManifestDigest": { "$ref": "./examples/ImportImageByManifestDigest.json" }, "ImportImageByTag": { "$ref": "./examples/ImportImageByTag.json" }, "ImportImageFromPublicRegistry": { "$ref": "./examples/ImportImageFromPublicRegistry.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/listCredentials": { "post": { "operationId": "Registries_ListCredentials", "tags": [ "Registries" ], "description": "Lists the login credentials for the specified container registry.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "registryName", "in": "path", "description": "The name of the container registry.", "required": true, "type": "string", "minLength": 5, "maxLength": 50, "pattern": "^[a-zA-Z0-9]*$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/RegistryListCredentialsResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "RegistryListCredentials": { "$ref": "./examples/RegistryListCredentials.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/listUsages": { "get": { "operationId": "Registries_ListUsages", "tags": [ "Registries" ], "description": "Gets the quota usages for the specified container registry.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "registryName", "in": "path", "description": "The name of the container registry.", "required": true, "type": "string", "minLength": 5, "maxLength": 50, "pattern": "^[a-zA-Z0-9]*$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/RegistryUsageListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "RegistryListUsages": { "$ref": "./examples/RegistryListUsages.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/privateEndpointConnections": { "get": { "operationId": "PrivateEndpointConnections_List", "tags": [ "PrivateEndpointConnections" ], "description": "List all private endpoint connections in a container registry.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "registryName", "in": "path", "description": "The name of the container registry.", "required": true, "type": "string", "minLength": 5, "maxLength": 50, "pattern": "^[a-zA-Z0-9]*$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/PrivateEndpointConnectionListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "PrivateEndpointConnectionList": { "$ref": "./examples/PrivateEndpointConnectionList.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/privateEndpointConnections/{privateEndpointConnectionName}": { "get": { "operationId": "PrivateEndpointConnections_Get", "tags": [ "PrivateEndpointConnections" ], "description": "Get the specified private endpoint connection associated with the container registry.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "registryName", "in": "path", "description": "The name of the container registry.", "required": true, "type": "string", "minLength": 5, "maxLength": 50, "pattern": "^[a-zA-Z0-9]*$" }, { "name": "privateEndpointConnectionName", "in": "path", "description": "The name of the private endpoint connection.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/PrivateEndpointConnection" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "PrivateEndpointConnectionGet": { "$ref": "./examples/PrivateEndpointConnectionGet.json" } } }, "put": { "operationId": "PrivateEndpointConnections_CreateOrUpdate", "tags": [ "PrivateEndpointConnections" ], "description": "Update the state of specified private endpoint connection associated with the container registry.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "registryName", "in": "path", "description": "The name of the container registry.", "required": true, "type": "string", "minLength": 5, "maxLength": 50, "pattern": "^[a-zA-Z0-9]*$" }, { "name": "privateEndpointConnectionName", "in": "path", "description": "The name of the private endpoint connection.", "required": true, "type": "string" }, { "name": "privateEndpointConnection", "in": "body", "description": "The parameters for creating a private endpoint connection.", "required": true, "schema": { "$ref": "#/definitions/PrivateEndpointConnection" } } ], "responses": { "200": { "description": "Resource 'PrivateEndpointConnection' update operation succeeded", "schema": { "$ref": "#/definitions/PrivateEndpointConnection" } }, "201": { "description": "Resource 'PrivateEndpointConnection' create operation succeeded", "schema": { "$ref": "#/definitions/PrivateEndpointConnection" }, "headers": { "Azure-AsyncOperation": { "type": "string", "description": "A link to the status monitor" }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "PrivateEndpointConnectionCreateOrUpdate": { "$ref": "./examples/PrivateEndpointConnectionCreateOrUpdate.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "azure-async-operation", "final-state-schema": "#/definitions/PrivateEndpointConnection" }, "x-ms-long-running-operation": true }, "delete": { "operationId": "PrivateEndpointConnections_Delete", "tags": [ "PrivateEndpointConnections" ], "description": "Deletes the specified private endpoint connection associated with the container registry.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "registryName", "in": "path", "description": "The name of the container registry.", "required": true, "type": "string", "minLength": 5, "maxLength": 50, "pattern": "^[a-zA-Z0-9]*$" }, { "name": "privateEndpointConnectionName", "in": "path", "description": "The name of the private endpoint connection.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Resource deleted successfully." }, "202": { "description": "Resource deletion accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "204": { "description": "Resource does not exist." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "PrivateEndpointConnectionDelete": { "$ref": "./examples/PrivateEndpointConnectionDelete.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/privateLinkResources": { "get": { "operationId": "Registries_ListPrivateLinkResources", "tags": [ "PrivateLinkResources" ], "description": "Lists the private link resources for a container registry.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "registryName", "in": "path", "description": "The name of the container registry.", "required": true, "type": "string", "minLength": 5, "maxLength": 50, "pattern": "^[a-zA-Z0-9]*$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/PrivateLinkResourceListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "RegistryListPrivateLinkResources": { "$ref": "./examples/RegistryListPrivateLinkResources.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/privateLinkResources/{groupName}": { "get": { "operationId": "Registries_GetPrivateLinkResource", "tags": [ "PrivateLinkResources" ], "description": "Gets a private link resource by a specified group name for a container registry.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "registryName", "in": "path", "description": "The name of the container registry.", "required": true, "type": "string", "minLength": 5, "maxLength": 50, "pattern": "^[a-zA-Z0-9]*$" }, { "name": "groupName", "in": "path", "description": "The name of the private link associated with the Azure resource.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/privatelinks.json#/definitions/PrivateLinkResource" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "RegistryGetPrivateLinkResource": { "$ref": "./examples/RegistryGetPrivateLinkResource.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/regenerateCredential": { "post": { "operationId": "Registries_RegenerateCredential", "tags": [ "Registries" ], "description": "Regenerates one of the login credentials for the specified container registry.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "registryName", "in": "path", "description": "The name of the container registry.", "required": true, "type": "string", "minLength": 5, "maxLength": 50, "pattern": "^[a-zA-Z0-9]*$" }, { "name": "regenerateCredentialParameters", "in": "body", "description": "Specifies name of the password which should be regenerated -- password or password2.", "required": true, "schema": { "$ref": "#/definitions/RegenerateCredentialParameters" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/RegistryListCredentialsResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "RegistryRegenerateCredential": { "$ref": "./examples/RegistryRegenerateCredential.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/replications": { "get": { "operationId": "Replications_List", "tags": [ "Replications" ], "description": "Lists all the replications for the specified container registry.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "registryName", "in": "path", "description": "The name of the container registry.", "required": true, "type": "string", "minLength": 5, "maxLength": 50, "pattern": "^[a-zA-Z0-9]*$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ReplicationListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "ReplicationList": { "$ref": "./examples/ReplicationList.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/replications/{replicationName}": { "get": { "operationId": "Replications_Get", "tags": [ "Replications" ], "description": "Gets the properties of the specified replication.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "registryName", "in": "path", "description": "The name of the container registry.", "required": true, "type": "string", "minLength": 5, "maxLength": 50, "pattern": "^[a-zA-Z0-9]*$" }, { "name": "replicationName", "in": "path", "description": "The name of the replication.", "required": true, "type": "string", "minLength": 5, "maxLength": 50, "pattern": "^[a-zA-Z0-9]*$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/Replication" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "ReplicationGet": { "$ref": "./examples/ReplicationGet.json" } } }, "put": { "operationId": "Replications_Create", "tags": [ "Replications" ], "description": "Creates a replication for a container registry with the specified parameters.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "registryName", "in": "path", "description": "The name of the container registry.", "required": true, "type": "string", "minLength": 5, "maxLength": 50, "pattern": "^[a-zA-Z0-9]*$" }, { "name": "replicationName", "in": "path", "description": "The name of the replication.", "required": true, "type": "string", "minLength": 5, "maxLength": 50, "pattern": "^[a-zA-Z0-9]*$" }, { "name": "replication", "in": "body", "description": "The parameters for creating a replication.", "required": true, "schema": { "$ref": "#/definitions/Replication" } } ], "responses": { "200": { "description": "Resource 'Replication' update operation succeeded", "schema": { "$ref": "#/definitions/Replication" } }, "201": { "description": "Resource 'Replication' create operation succeeded", "schema": { "$ref": "#/definitions/Replication" }, "headers": { "Azure-AsyncOperation": { "type": "string", "description": "A link to the status monitor" }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "ReplicationCreate": { "$ref": "./examples/ReplicationCreate.json" }, "ReplicationCreateZoneRedundant": { "$ref": "./examples/ReplicationCreateZoneRedundant.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "azure-async-operation", "final-state-schema": "#/definitions/Replication" }, "x-ms-long-running-operation": true }, "patch": { "operationId": "Replications_Update", "tags": [ "Replications" ], "description": "Updates a replication for a container registry with the specified parameters.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "registryName", "in": "path", "description": "The name of the container registry.", "required": true, "type": "string", "minLength": 5, "maxLength": 50, "pattern": "^[a-zA-Z0-9]*$" }, { "name": "replicationName", "in": "path", "description": "The name of the replication.", "required": true, "type": "string", "minLength": 5, "maxLength": 50, "pattern": "^[a-zA-Z0-9]*$" }, { "name": "replicationUpdateParameters", "in": "body", "description": "The parameters for updating a replication.", "required": true, "schema": { "$ref": "#/definitions/ReplicationUpdateParameters" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/Replication" } }, "201": { "description": "Resource 'Replication' create operation succeeded", "schema": { "$ref": "#/definitions/Replication" }, "headers": { "Azure-AsyncOperation": { "type": "string", "description": "A link to the status monitor" }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "ReplicationUpdate": { "$ref": "./examples/ReplicationUpdate.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "azure-async-operation", "final-state-schema": "#/definitions/Replication" }, "x-ms-long-running-operation": true }, "delete": { "operationId": "Replications_Delete", "tags": [ "Replications" ], "description": "Deletes a replication from a container registry.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "registryName", "in": "path", "description": "The name of the container registry.", "required": true, "type": "string", "minLength": 5, "maxLength": 50, "pattern": "^[a-zA-Z0-9]*$" }, { "name": "replicationName", "in": "path", "description": "The name of the replication.", "required": true, "type": "string", "minLength": 5, "maxLength": 50, "pattern": "^[a-zA-Z0-9]*$" } ], "responses": { "200": { "description": "Resource deleted successfully." }, "202": { "description": "Resource deletion accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "204": { "description": "Resource does not exist." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "ReplicationDelete": { "$ref": "./examples/ReplicationDelete.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/scopeMaps": { "get": { "operationId": "ScopeMaps_List", "tags": [ "ScopeMaps" ], "description": "Lists all the scope maps for the specified container registry.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "registryName", "in": "path", "description": "The name of the container registry.", "required": true, "type": "string", "minLength": 5, "maxLength": 50, "pattern": "^[a-zA-Z0-9]*$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ScopeMapListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "ScopeMapList": { "$ref": "./examples/ScopeMapList.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/scopeMaps/{scopeMapName}": { "get": { "operationId": "ScopeMaps_Get", "tags": [ "ScopeMaps" ], "description": "Gets the properties of the specified scope map.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "registryName", "in": "path", "description": "The name of the container registry.", "required": true, "type": "string", "minLength": 5, "maxLength": 50, "pattern": "^[a-zA-Z0-9]*$" }, { "name": "scopeMapName", "in": "path", "description": "The name of the scope map.", "required": true, "type": "string", "minLength": 5, "maxLength": 50, "pattern": "^[a-zA-Z0-9-_]*$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ScopeMap" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "ScopeMapGet": { "$ref": "./examples/ScopeMapGet.json" } } }, "put": { "operationId": "ScopeMaps_Create", "tags": [ "ScopeMaps" ], "description": "Creates a scope map for a container registry with the specified parameters.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "registryName", "in": "path", "description": "The name of the container registry.", "required": true, "type": "string", "minLength": 5, "maxLength": 50, "pattern": "^[a-zA-Z0-9]*$" }, { "name": "scopeMapName", "in": "path", "description": "The name of the scope map.", "required": true, "type": "string", "minLength": 5, "maxLength": 50, "pattern": "^[a-zA-Z0-9-_]*$" }, { "name": "scopeMapCreateParameters", "in": "body", "description": "The parameters for creating a scope map.", "required": true, "schema": { "$ref": "#/definitions/ScopeMap" } } ], "responses": { "200": { "description": "Resource 'ScopeMap' update operation succeeded", "schema": { "$ref": "#/definitions/ScopeMap" } }, "201": { "description": "Resource 'ScopeMap' create operation succeeded", "schema": { "$ref": "#/definitions/ScopeMap" }, "headers": { "Azure-AsyncOperation": { "type": "string", "description": "A link to the status monitor" }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "ScopeMapCreate": { "$ref": "./examples/ScopeMapCreate.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "azure-async-operation", "final-state-schema": "#/definitions/ScopeMap" }, "x-ms-long-running-operation": true }, "patch": { "operationId": "ScopeMaps_Update", "tags": [ "ScopeMaps" ], "description": "Updates a scope map with the specified parameters.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "registryName", "in": "path", "description": "The name of the container registry.", "required": true, "type": "string", "minLength": 5, "maxLength": 50, "pattern": "^[a-zA-Z0-9]*$" }, { "name": "scopeMapName", "in": "path", "description": "The name of the scope map.", "required": true, "type": "string", "minLength": 5, "maxLength": 50, "pattern": "^[a-zA-Z0-9-_]*$" }, { "name": "scopeMapUpdateParameters", "in": "body", "description": "The parameters for updating a scope map.", "required": true, "schema": { "$ref": "#/definitions/ScopeMapUpdateParameters" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ScopeMap" } }, "201": { "description": "Resource 'ScopeMap' create operation succeeded", "schema": { "$ref": "#/definitions/ScopeMap" }, "headers": { "Azure-AsyncOperation": { "type": "string", "description": "A link to the status monitor" }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "ScopeMapUpdate": { "$ref": "./examples/ScopeMapUpdate.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "azure-async-operation", "final-state-schema": "#/definitions/ScopeMap" }, "x-ms-long-running-operation": true }, "delete": { "operationId": "ScopeMaps_Delete", "tags": [ "ScopeMaps" ], "description": "Deletes a scope map from a container registry.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "registryName", "in": "path", "description": "The name of the container registry.", "required": true, "type": "string", "minLength": 5, "maxLength": 50, "pattern": "^[a-zA-Z0-9]*$" }, { "name": "scopeMapName", "in": "path", "description": "The name of the scope map.", "required": true, "type": "string", "minLength": 5, "maxLength": 50, "pattern": "^[a-zA-Z0-9-_]*$" } ], "responses": { "200": { "description": "Resource deleted successfully." }, "202": { "description": "Resource deletion accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "204": { "description": "Resource does not exist." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "ScopeMapDelete": { "$ref": "./examples/ScopeMapDelete.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/tokens": { "get": { "operationId": "Tokens_List", "tags": [ "Tokens" ], "description": "Lists all the tokens for the specified container registry.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "registryName", "in": "path", "description": "The name of the container registry.", "required": true, "type": "string", "minLength": 5, "maxLength": 50, "pattern": "^[a-zA-Z0-9]*$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/TokenListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "TokenList": { "$ref": "./examples/TokenList.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/tokens/{tokenName}": { "get": { "operationId": "Tokens_Get", "tags": [ "Tokens" ], "description": "Gets the properties of the specified token.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "registryName", "in": "path", "description": "The name of the container registry.", "required": true, "type": "string", "minLength": 5, "maxLength": 50, "pattern": "^[a-zA-Z0-9]*$" }, { "name": "tokenName", "in": "path", "description": "The name of the token.", "required": true, "type": "string", "minLength": 5, "maxLength": 50, "pattern": "^[a-zA-Z0-9-]*$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/Token" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "TokenGet": { "$ref": "./examples/TokenGet.json" } } }, "put": { "operationId": "Tokens_Create", "tags": [ "Tokens" ], "description": "Creates a token for a container registry with the specified parameters.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "registryName", "in": "path", "description": "The name of the container registry.", "required": true, "type": "string", "minLength": 5, "maxLength": 50, "pattern": "^[a-zA-Z0-9]*$" }, { "name": "tokenName", "in": "path", "description": "The name of the token.", "required": true, "type": "string", "minLength": 5, "maxLength": 50, "pattern": "^[a-zA-Z0-9-]*$" }, { "name": "tokenCreateParameters", "in": "body", "description": "The parameters for creating a token.", "required": true, "schema": { "$ref": "#/definitions/Token" } } ], "responses": { "200": { "description": "Resource 'Token' update operation succeeded", "schema": { "$ref": "#/definitions/Token" } }, "201": { "description": "Resource 'Token' create operation succeeded", "schema": { "$ref": "#/definitions/Token" }, "headers": { "Azure-AsyncOperation": { "type": "string", "description": "A link to the status monitor" }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "TokenCreate": { "$ref": "./examples/TokenCreate.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "azure-async-operation", "final-state-schema": "#/definitions/Token" }, "x-ms-long-running-operation": true }, "patch": { "operationId": "Tokens_Update", "tags": [ "Tokens" ], "description": "Updates a token with the specified parameters.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "registryName", "in": "path", "description": "The name of the container registry.", "required": true, "type": "string", "minLength": 5, "maxLength": 50, "pattern": "^[a-zA-Z0-9]*$" }, { "name": "tokenName", "in": "path", "description": "The name of the token.", "required": true, "type": "string", "minLength": 5, "maxLength": 50, "pattern": "^[a-zA-Z0-9-]*$" }, { "name": "tokenUpdateParameters", "in": "body", "description": "The parameters for updating a token.", "required": true, "schema": { "$ref": "#/definitions/TokenUpdateParameters" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/Token" } }, "201": { "description": "Resource 'Token' create operation succeeded", "schema": { "$ref": "#/definitions/Token" }, "headers": { "Azure-AsyncOperation": { "type": "string", "description": "A link to the status monitor" }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "TokenUpdate": { "$ref": "./examples/TokenUpdate.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "azure-async-operation", "final-state-schema": "#/definitions/Token" }, "x-ms-long-running-operation": true }, "delete": { "operationId": "Tokens_Delete", "tags": [ "Tokens" ], "description": "Deletes a token from a container registry.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "registryName", "in": "path", "description": "The name of the container registry.", "required": true, "type": "string", "minLength": 5, "maxLength": 50, "pattern": "^[a-zA-Z0-9]*$" }, { "name": "tokenName", "in": "path", "description": "The name of the token.", "required": true, "type": "string", "minLength": 5, "maxLength": 50, "pattern": "^[a-zA-Z0-9-]*$" } ], "responses": { "200": { "description": "Resource deleted successfully." }, "202": { "description": "Resource deletion accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "204": { "description": "Resource does not exist." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "TokenDelete": { "$ref": "./examples/TokenDelete.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/webhooks": { "get": { "operationId": "Webhooks_List", "tags": [ "Webhooks" ], "description": "Lists all the webhooks for the specified container registry.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "registryName", "in": "path", "description": "The name of the container registry.", "required": true, "type": "string", "minLength": 5, "maxLength": 50, "pattern": "^[a-zA-Z0-9]*$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/WebhookListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "WebhookList": { "$ref": "./examples/WebhookList.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/webhooks/{webhookName}": { "get": { "operationId": "Webhooks_Get", "tags": [ "Webhooks" ], "description": "Gets the properties of the specified webhook.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "registryName", "in": "path", "description": "The name of the container registry.", "required": true, "type": "string", "minLength": 5, "maxLength": 50, "pattern": "^[a-zA-Z0-9]*$" }, { "name": "webhookName", "in": "path", "description": "The name of the webhook.", "required": true, "type": "string", "minLength": 5, "maxLength": 50, "pattern": "^[a-zA-Z0-9]*$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/Webhook" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "WebhookGet": { "$ref": "./examples/WebhookGet.json" } } }, "put": { "operationId": "Webhooks_Create", "tags": [ "Webhooks" ], "description": "Creates a webhook for a container registry with the specified parameters.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "registryName", "in": "path", "description": "The name of the container registry.", "required": true, "type": "string", "minLength": 5, "maxLength": 50, "pattern": "^[a-zA-Z0-9]*$" }, { "name": "webhookName", "in": "path", "description": "The name of the webhook.", "required": true, "type": "string", "minLength": 5, "maxLength": 50, "pattern": "^[a-zA-Z0-9]*$" }, { "name": "webhookCreateParameters", "in": "body", "description": "The parameters for creating a webhook.", "required": true, "schema": { "$ref": "#/definitions/WebhookCreateParameters" } } ], "responses": { "200": { "description": "Resource 'Webhook' update operation succeeded", "schema": { "$ref": "#/definitions/Webhook" } }, "201": { "description": "Resource 'Webhook' create operation succeeded", "schema": { "$ref": "#/definitions/Webhook" }, "headers": { "Azure-AsyncOperation": { "type": "string", "description": "A link to the status monitor" }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "WebhookCreate": { "$ref": "./examples/WebhookCreate.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "azure-async-operation", "final-state-schema": "#/definitions/Webhook" }, "x-ms-long-running-operation": true }, "patch": { "operationId": "Webhooks_Update", "tags": [ "Webhooks" ], "description": "Updates a webhook with the specified parameters.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "registryName", "in": "path", "description": "The name of the container registry.", "required": true, "type": "string", "minLength": 5, "maxLength": 50, "pattern": "^[a-zA-Z0-9]*$" }, { "name": "webhookName", "in": "path", "description": "The name of the webhook.", "required": true, "type": "string", "minLength": 5, "maxLength": 50, "pattern": "^[a-zA-Z0-9]*$" }, { "name": "webhookUpdateParameters", "in": "body", "description": "The parameters for updating a webhook.", "required": true, "schema": { "$ref": "#/definitions/WebhookUpdateParameters" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/Webhook" } }, "201": { "description": "Resource 'Webhook' create operation succeeded", "schema": { "$ref": "#/definitions/Webhook" }, "headers": { "Azure-AsyncOperation": { "type": "string", "description": "A link to the status monitor" }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "WebhookUpdate": { "$ref": "./examples/WebhookUpdate.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "azure-async-operation", "final-state-schema": "#/definitions/Webhook" }, "x-ms-long-running-operation": true }, "delete": { "operationId": "Webhooks_Delete", "tags": [ "Webhooks" ], "description": "Deletes a webhook from a container registry.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "registryName", "in": "path", "description": "The name of the container registry.", "required": true, "type": "string", "minLength": 5, "maxLength": 50, "pattern": "^[a-zA-Z0-9]*$" }, { "name": "webhookName", "in": "path", "description": "The name of the webhook.", "required": true, "type": "string", "minLength": 5, "maxLength": 50, "pattern": "^[a-zA-Z0-9]*$" } ], "responses": { "200": { "description": "Resource deleted successfully." }, "202": { "description": "Resource deletion accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "204": { "description": "Resource does not exist." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "WebhookDelete": { "$ref": "./examples/WebhookDelete.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/webhooks/{webhookName}/getCallbackConfig": { "post": { "operationId": "Webhooks_GetCallbackConfig", "tags": [ "Webhooks" ], "description": "Gets the configuration of service URI and custom headers for the webhook.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "registryName", "in": "path", "description": "The name of the container registry.", "required": true, "type": "string", "minLength": 5, "maxLength": 50, "pattern": "^[a-zA-Z0-9]*$" }, { "name": "webhookName", "in": "path", "description": "The name of the webhook.", "required": true, "type": "string", "minLength": 5, "maxLength": 50, "pattern": "^[a-zA-Z0-9]*$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/CallbackConfig" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "WebhookGetCallbackConfig": { "$ref": "./examples/WebhookGetCallbackConfig.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/webhooks/{webhookName}/listEvents": { "post": { "operationId": "Webhooks_ListEvents", "tags": [ "Webhooks" ], "description": "Lists recent events for the specified webhook.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "registryName", "in": "path", "description": "The name of the container registry.", "required": true, "type": "string", "minLength": 5, "maxLength": 50, "pattern": "^[a-zA-Z0-9]*$" }, { "name": "webhookName", "in": "path", "description": "The name of the webhook.", "required": true, "type": "string", "minLength": 5, "maxLength": 50, "pattern": "^[a-zA-Z0-9]*$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/EventListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "WebhookListEvents": { "$ref": "./examples/WebhookListEvents.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/webhooks/{webhookName}/ping": { "post": { "operationId": "Webhooks_Ping", "tags": [ "Webhooks" ], "description": "Triggers a ping event to be sent to the webhook.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "registryName", "in": "path", "description": "The name of the container registry.", "required": true, "type": "string", "minLength": 5, "maxLength": 50, "pattern": "^[a-zA-Z0-9]*$" }, { "name": "webhookName", "in": "path", "description": "The name of the webhook.", "required": true, "type": "string", "minLength": 5, "maxLength": 50, "pattern": "^[a-zA-Z0-9]*$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/EventInfo" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "WebhookPing": { "$ref": "./examples/WebhookPing.json" } } } } }, "definitions": { "ActionsRequired": { "type": "string", "description": "A message indicating if changes on the service provider require any updates on the consumer.", "enum": [ "None", "Recreate" ], "x-ms-enum": { "name": "ActionsRequired", "modelAsString": true, "values": [ { "name": "None", "value": "None" }, { "name": "Recreate", "value": "Recreate" } ] } }, "ActivationProperties": { "type": "object", "description": "The activation properties of the connected registry.", "properties": { "status": { "$ref": "#/definitions/ActivationStatus", "description": "The activation status of the connected registry.", "readOnly": true } } }, "ActivationStatus": { "type": "string", "description": "The activation status of the connected registry.", "enum": [ "Active", "Inactive" ], "x-ms-enum": { "name": "ActivationStatus", "modelAsString": true, "values": [ { "name": "Active", "value": "Active" }, { "name": "Inactive", "value": "Inactive" } ] } }, "Actor": { "type": "object", "description": "The agent that initiated the event. For most situations, this could be from the authorization context of the request.", "properties": { "name": { "type": "string", "description": "The subject or username associated with the request context that generated the event." } } }, "AuthCredential": { "type": "object", "description": "Authentication credential stored for an upstream.", "properties": { "name": { "$ref": "#/definitions/CredentialName", "description": "The name of the credential." }, "usernameSecretIdentifier": { "type": "string", "description": "KeyVault Secret URI for accessing the username." }, "passwordSecretIdentifier": { "type": "string", "description": "KeyVault Secret URI for accessing the password." }, "credentialHealth": { "$ref": "#/definitions/CredentialHealth", "description": "This provides data pertaining to the health of the auth credential.", "readOnly": true } } }, "AzureADAuthenticationAsArmPolicy": { "type": "object", "description": "The policy for using Azure Resource Manager audience token for a container registry.", "properties": { "status": { "type": "string", "description": "The value that indicates whether the policy is enabled or not.", "default": "enabled", "enum": [ "enabled", "disabled" ], "x-ms-enum": { "name": "AzureADAuthenticationAsArmPolicyStatus", "modelAsString": true, "values": [ { "name": "enabled", "value": "enabled" }, { "name": "disabled", "value": "disabled" } ] } } } }, "CacheRule": { "type": "object", "description": "An object that represents a cache rule for a container registry.", "properties": { "properties": { "$ref": "#/definitions/CacheRuleProperties", "description": "The properties of the cache rule.", "x-ms-client-flatten": true } }, "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ProxyResource" } ] }, "CacheRuleProperties": { "type": "object", "description": "The properties of a cache rule.", "properties": { "credentialSetResourceId": { "type": "string", "description": "The ARM resource ID of the credential store which is associated with the cache rule." }, "sourceRepository": { "type": "string", "description": "Source repository pulled from upstream." }, "targetRepository": { "type": "string", "description": "Target repository specified in docker pull command.\nEg: docker pull myregistry.azurecr.io/{targetRepository}:{tag}" }, "creationDate": { "type": "string", "format": "date-time", "description": "The creation date of the cache rule.", "readOnly": true }, "provisioningState": { "$ref": "#/definitions/ProvisioningState", "description": "Provisioning state of the resource.", "readOnly": true } } }, "CacheRuleUpdateParameters": { "type": "object", "description": "The parameters for updating a cache rule.", "properties": { "properties": { "$ref": "#/definitions/CacheRuleUpdateProperties", "description": "The properties of the cache rule update parameters.", "x-ms-client-flatten": true } } }, "CacheRuleUpdateProperties": { "type": "object", "description": "The parameters for updating cache rule properties.", "properties": { "credentialSetResourceId": { "type": "string", "description": "The ARM resource ID of the credential store which is associated with the Cache rule." } } }, "CacheRulesListResult": { "type": "object", "description": "The result of a request to list cache rules for a container registry.", "properties": { "value": { "type": "array", "description": "The list of cache rules. Since this list may be incomplete, the nextLink field should be used to request the next list of cache rules.", "items": { "$ref": "#/definitions/CacheRule" } }, "nextLink": { "type": "string", "description": "The URI that can be used to request the next list of cache rules." } } }, "CallbackConfig": { "type": "object", "description": "The configuration of service URI and custom headers for the webhook.", "properties": { "serviceUri": { "type": "string", "description": "The service URI for the webhook to post notifications." }, "customHeaders": { "type": "object", "description": "Custom headers that will be added to the webhook notifications.", "additionalProperties": { "type": "string" } } }, "required": [ "serviceUri" ] }, "CertificateType": { "type": "string", "description": "The type of certificate location.", "enum": [ "LocalDirectory" ], "x-ms-enum": { "name": "CertificateType", "modelAsString": true, "values": [ { "name": "LocalDirectory", "value": "LocalDirectory" } ] } }, "ConnectedRegistry": { "type": "object", "description": "An object that represents a connected registry for a container registry.", "properties": { "properties": { "$ref": "#/definitions/ConnectedRegistryProperties", "description": "The properties of the connected registry.", "x-ms-client-flatten": true } }, "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ProxyResource" } ] }, "ConnectedRegistryListResult": { "type": "object", "description": "The result of a request to list connected registries for a container registry.", "properties": { "value": { "type": "array", "description": "The list of connected registries. Since this list may be incomplete, the nextLink field should be used to request the next list of connected registries.", "items": { "$ref": "#/definitions/ConnectedRegistry" } }, "nextLink": { "type": "string", "description": "The URI that can be used to request the next list of connected registries." } } }, "ConnectedRegistryMode": { "type": "string", "description": "The mode of the connected registry resource that indicates the permissions of the registry.", "enum": [ "ReadWrite", "ReadOnly", "Registry", "Mirror" ], "x-ms-enum": { "name": "ConnectedRegistryMode", "modelAsString": true, "values": [ { "name": "ReadWrite", "value": "ReadWrite" }, { "name": "ReadOnly", "value": "ReadOnly" }, { "name": "Registry", "value": "Registry" }, { "name": "Mirror", "value": "Mirror" } ] } }, "ConnectedRegistryProperties": { "type": "object", "description": "The properties of a connected registry.", "properties": { "provisioningState": { "$ref": "#/definitions/ProvisioningState", "description": "Provisioning state of the resource.", "readOnly": true }, "mode": { "$ref": "#/definitions/ConnectedRegistryMode", "description": "The mode of the connected registry resource that indicates the permissions of the registry." }, "version": { "type": "string", "description": "The current version of ACR runtime on the connected registry.", "readOnly": true }, "connectionState": { "$ref": "#/definitions/ConnectionState", "description": "The current connection state of the connected registry.", "readOnly": true }, "lastActivityTime": { "type": "string", "format": "date-time", "description": "The last activity time of the connected registry.", "readOnly": true }, "activation": { "$ref": "#/definitions/ActivationProperties", "description": "The activation properties of the connected registry.", "readOnly": true }, "parent": { "$ref": "#/definitions/ParentProperties", "description": "The parent of the connected registry." }, "clientTokenIds": { "type": "array", "description": "The list of the ACR token resource IDs used to authenticate clients to the connected registry.", "items": { "type": "string" } }, "loginServer": { "$ref": "#/definitions/LoginServerProperties", "description": "The login server properties of the connected registry." }, "logging": { "$ref": "#/definitions/LoggingProperties", "description": "The logging properties of the connected registry." }, "statusDetails": { "type": "array", "description": "The list of current statuses of the connected registry.", "items": { "$ref": "#/definitions/StatusDetailProperties" }, "readOnly": true, "x-ms-identifiers": [ "correlationId" ] }, "notificationsList": { "type": "array", "description": "The list of notifications subscription information for the connected registry.", "items": { "type": "string" } }, "garbageCollection": { "$ref": "#/definitions/GarbageCollectionProperties", "description": "The garbage collection properties of the connected registry." } }, "required": [ "mode", "parent" ] }, "ConnectedRegistryUpdateParameters": { "type": "object", "description": "The parameters for updating a connected registry.", "properties": { "properties": { "$ref": "#/definitions/ConnectedRegistryUpdateProperties", "description": "The properties of the connected registry update parameters.", "x-ms-client-flatten": true } } }, "ConnectedRegistryUpdateProperties": { "type": "object", "description": "The parameters for updating token properties.", "properties": { "syncProperties": { "$ref": "#/definitions/SyncUpdateProperties", "description": "The sync properties of the connected registry with its parent." }, "logging": { "$ref": "#/definitions/LoggingProperties", "description": "The logging properties of the connected registry." }, "clientTokenIds": { "type": "array", "description": "The list of the ACR token resource IDs used to authenticate clients to the connected registry.", "items": { "type": "string" } }, "notificationsList": { "type": "array", "description": "The list of notifications subscription information for the connected registry.", "items": { "type": "string" } }, "garbageCollection": { "$ref": "#/definitions/GarbageCollectionProperties", "description": "The garbage collection properties of the connected registry." } } }, "ConnectionState": { "type": "string", "description": "The current connection state of the connected registry.", "enum": [ "Online", "Offline", "Syncing", "Unhealthy" ], "x-ms-enum": { "name": "ConnectionState", "modelAsString": true, "values": [ { "name": "Online", "value": "Online" }, { "name": "Offline", "value": "Offline" }, { "name": "Syncing", "value": "Syncing" }, { "name": "Unhealthy", "value": "Unhealthy" } ] } }, "ConnectionStatus": { "type": "string", "description": "The private link service connection status.", "enum": [ "Approved", "Pending", "Rejected", "Disconnected" ], "x-ms-enum": { "name": "ConnectionStatus", "modelAsString": true, "values": [ { "name": "Approved", "value": "Approved" }, { "name": "Pending", "value": "Pending" }, { "name": "Rejected", "value": "Rejected" }, { "name": "Disconnected", "value": "Disconnected" } ] } }, "ContainerRegistryResourceType": { "type": "string", "description": "The resource type for Container Registry.", "enum": [ "Microsoft.ContainerRegistry/registries" ], "x-ms-enum": { "name": "ContainerRegistryResourceType", "modelAsString": false } }, "CredentialHealth": { "type": "object", "description": "The health of the auth credential.", "properties": { "status": { "$ref": "#/definitions/CredentialHealthStatus", "description": "The health status of credential." }, "errorCode": { "type": "string", "description": "Error code representing the health check error." }, "errorMessage": { "type": "string", "description": "Descriptive message representing the health check error." } } }, "CredentialHealthStatus": { "type": "string", "description": "The health status of credential.", "enum": [ "Healthy", "Unhealthy" ], "x-ms-enum": { "name": "CredentialHealthStatus", "modelAsString": true, "values": [ { "name": "Healthy", "value": "Healthy" }, { "name": "Unhealthy", "value": "Unhealthy" } ] } }, "CredentialName": { "type": "string", "description": "The name of the credential.", "enum": [ "Credential1" ], "x-ms-enum": { "name": "CredentialName", "modelAsString": true, "values": [ { "name": "Credential1", "value": "Credential1" } ] } }, "CredentialSet": { "type": "object", "description": "An object that represents a credential set resource for a container registry.", "properties": { "properties": { "$ref": "#/definitions/CredentialSetProperties", "description": "The properties of the credential set.", "x-ms-client-flatten": true }, "identity": { "$ref": "#/definitions/IdentityProperties", "description": "Identities associated with the resource. This is used to access the KeyVault secrets." } }, "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ProxyResource" } ] }, "CredentialSetListResult": { "type": "object", "description": "The result of a request to list credential sets for a container registry.", "properties": { "value": { "type": "array", "description": "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.", "items": { "$ref": "#/definitions/CredentialSet" } }, "nextLink": { "type": "string", "description": "The URI that can be used to request the next list of credential sets." } } }, "CredentialSetProperties": { "type": "object", "description": "The properties of a credential set resource.", "properties": { "loginServer": { "type": "string", "description": "The credentials are stored for this upstream or login server." }, "authCredentials": { "type": "array", "description": "List of authentication credentials stored for an upstream.\nUsually consists of a primary and an optional secondary credential.", "items": { "$ref": "#/definitions/AuthCredential" }, "x-ms-identifiers": [ "name" ] }, "creationDate": { "type": "string", "format": "date-time", "description": "The creation date of credential store resource.", "readOnly": true }, "provisioningState": { "$ref": "#/definitions/ProvisioningState", "description": "Provisioning state of the resource.", "readOnly": true } } }, "CredentialSetUpdateParameters": { "type": "object", "description": "The parameters for updating a credential set", "properties": { "properties": { "$ref": "#/definitions/CredentialSetUpdateProperties", "description": "The properties of the credential set update parameters", "x-ms-client-flatten": true }, "identity": { "$ref": "#/definitions/IdentityProperties", "description": "Identities associated with the resource. This is used to access the KeyVault secrets." } } }, "CredentialSetUpdateProperties": { "type": "object", "description": "The parameters for updating credential set properties.", "properties": { "authCredentials": { "type": "array", "description": "List of authentication credentials stored for an upstream.\nUsually consists of a primary and an optional secondary credential.", "items": { "$ref": "#/definitions/AuthCredential" }, "x-ms-identifiers": [ "name" ] } } }, "EncryptionProperty": { "type": "object", "properties": { "status": { "$ref": "#/definitions/EncryptionStatus", "description": "Indicates whether or not the encryption is enabled for container registry." }, "keyVaultProperties": { "$ref": "#/definitions/KeyVaultProperties", "description": "Key vault properties." } } }, "EncryptionStatus": { "type": "string", "description": "Indicates whether or not the encryption is enabled for container registry.", "enum": [ "enabled", "disabled" ], "x-ms-enum": { "name": "EncryptionStatus", "modelAsString": true, "values": [ { "name": "enabled", "value": "enabled" }, { "name": "disabled", "value": "disabled" } ] } }, "Event": { "type": "object", "description": "The event for a webhook.", "properties": { "eventRequestMessage": { "$ref": "#/definitions/EventRequestMessage", "description": "The event request message sent to the service URI." }, "eventResponseMessage": { "$ref": "#/definitions/EventResponseMessage", "description": "The event response message received from the service URI." } }, "allOf": [ { "$ref": "#/definitions/EventInfo" } ] }, "EventContent": { "type": "object", "description": "The content of the event request message.", "properties": { "id": { "type": "string", "description": "The event ID." }, "timestamp": { "type": "string", "format": "date-time", "description": "The time at which the event occurred." }, "action": { "type": "string", "description": "The action that encompasses the provided event." }, "target": { "$ref": "#/definitions/Target", "description": "The target of the event." }, "request": { "$ref": "#/definitions/Request", "description": "The request that generated the event." }, "actor": { "$ref": "#/definitions/Actor", "description": "The agent that initiated the event. For most situations, this could be from the authorization context of the request." }, "source": { "$ref": "#/definitions/Source", "description": "The registry node that generated the event. Put differently, while the actor initiates the event, the source generates it." } } }, "EventInfo": { "type": "object", "description": "The basic information of an event.", "properties": { "id": { "type": "string", "description": "The event ID." } } }, "EventListResult": { "type": "object", "description": "The result of a request to list events for a webhook.", "properties": { "value": { "type": "array", "description": "The list of events. Since this list may be incomplete, the nextLink field should be used to request the next list of events.", "items": { "$ref": "#/definitions/Event" } }, "nextLink": { "type": "string", "description": "The URI that can be used to request the next list of events." } } }, "EventRequestMessage": { "type": "object", "description": "The event request message sent to the service URI.", "properties": { "content": { "$ref": "#/definitions/EventContent", "description": "The content of the event request message." }, "headers": { "type": "object", "description": "The headers of the event request message.", "additionalProperties": { "type": "string" } }, "method": { "type": "string", "description": "The HTTP method used to send the event request message." }, "requestUri": { "type": "string", "description": "The URI used to send the event request message." }, "version": { "type": "string", "description": "The HTTP message version." } } }, "EventResponseMessage": { "type": "object", "description": "The event response message received from the service URI.", "properties": { "content": { "type": "string", "description": "The content of the event response message." }, "headers": { "type": "object", "description": "The headers of the event response message.", "additionalProperties": { "type": "string" } }, "reasonPhrase": { "type": "string", "description": "The reason phrase of the event response message." }, "statusCode": { "type": "string", "description": "The status code of the event response message." }, "version": { "type": "string", "description": "The HTTP message version." } } }, "ExportPolicy": { "type": "object", "description": "The export policy for a container registry.", "properties": { "status": { "type": "string", "description": "The value that indicates whether the policy is enabled or not.", "default": "enabled", "enum": [ "enabled", "disabled" ], "x-ms-enum": { "name": "ExportPolicyStatus", "modelAsString": true, "values": [ { "name": "enabled", "value": "enabled" }, { "name": "disabled", "value": "disabled" } ] } } } }, "GarbageCollectionProperties": { "type": "object", "description": "The garbage collection properties of the connected registry.", "properties": { "enabled": { "type": "boolean", "description": "Indicates whether garbage collection is enabled for the connected registry." }, "schedule": { "type": "string", "description": "The cron expression indicating the schedule that the connected registry will run garbage collection." } } }, "GenerateCredentialsParameters": { "type": "object", "description": "The parameters used to generate credentials for a specified token or user of a container registry.", "properties": { "tokenId": { "type": "string", "description": "The resource ID of the token for which credentials have to be generated." }, "expiry": { "type": "string", "format": "date-time", "description": "The expiry date of the generated credentials after which the credentials become invalid." }, "name": { "$ref": "#/definitions/TokenPasswordName", "description": "Specifies name of the password which should be regenerated if any -- password1 or password2." } } }, "GenerateCredentialsResult": { "type": "object", "description": "The response from the GenerateCredentials operation.", "properties": { "username": { "type": "string", "description": "The username for a container registry." }, "passwords": { "type": "array", "description": "The list of passwords for a container registry.", "items": { "$ref": "#/definitions/TokenPassword" }, "x-ms-identifiers": [] } } }, "IPRule": { "type": "object", "description": "IP rule with specific IP or IP range in CIDR format.", "properties": { "action": { "type": "string", "description": "The action of IP ACL rule.", "default": "Allow", "enum": [ "Allow" ], "x-ms-enum": { "name": "Action", "modelAsString": true, "values": [ { "name": "Allow", "value": "Allow" } ] } }, "value": { "type": "string", "description": "Specifies the IP or IP range in CIDR format. Only IPV4 address is allowed.", "x-ms-client-name": "IPAddressOrRange" } }, "required": [ "value" ] }, "IdentityProperties": { "type": "object", "description": "Managed identity for the resource.", "properties": { "principalId": { "type": "string", "description": "The principal ID of resource identity.", "readOnly": true }, "tenantId": { "type": "string", "description": "The tenant ID of resource.", "readOnly": true }, "type": { "$ref": "#/definitions/ResourceIdentityType", "description": "The identity type." }, "userAssignedIdentities": { "type": "object", "description": "The list of user identities associated with the resource. The user identity\ndictionary key references will be ARM resource ids in the form:\n'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/\nproviders/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.", "additionalProperties": { "$ref": "#/definitions/UserIdentityProperties" } } } }, "ImportImageParameters": { "type": "object", "properties": { "source": { "$ref": "#/definitions/ImportSource", "description": "The source of the image." }, "targetTags": { "type": "array", "description": "List of strings of the form repo[:tag]. When tag is omitted the source will be used (or 'latest' if source tag is also omitted).", "items": { "type": "string" } }, "untaggedTargetRepositories": { "type": "array", "description": "List of strings of repository names to do a manifest only copy. No tag will be created.", "items": { "type": "string" } }, "mode": { "type": "string", "description": "When Force, any existing target tags will be overwritten. When NoForce, any existing target tags will fail the operation before any copying begins.", "default": "NoForce", "enum": [ "NoForce", "Force" ], "x-ms-enum": { "name": "ImportMode", "modelAsString": true, "values": [ { "name": "NoForce", "value": "NoForce" }, { "name": "Force", "value": "Force" } ] } } }, "required": [ "source" ] }, "ImportSource": { "type": "object", "properties": { "resourceId": { "type": "string", "description": "The resource identifier of the source Azure Container Registry." }, "registryUri": { "type": "string", "description": "The address of the source registry (e.g. 'mcr.microsoft.com')." }, "credentials": { "$ref": "#/definitions/ImportSourceCredentials", "description": "Credentials used when importing from a registry uri." }, "sourceImage": { "type": "string", "description": "Repository name of the source image.\nSpecify an image by repository ('hello-world'). This will use the 'latest' tag.\nSpecify an image by tag ('hello-world:latest').\nSpecify an image by sha256-based manifest digest ('hello-world@sha256:abc123')." } }, "required": [ "sourceImage" ] }, "ImportSourceCredentials": { "type": "object", "properties": { "username": { "type": "string", "description": "The username to authenticate with the source registry." }, "password": { "type": "string", "description": "The password used to authenticate with the source registry." } }, "required": [ "password" ] }, "KeyVaultProperties": { "type": "object", "properties": { "keyIdentifier": { "type": "string", "description": "Key vault uri to access the encryption key." }, "versionedKeyIdentifier": { "type": "string", "description": "The fully qualified key identifier that includes the version of the key that is actually used for encryption.", "readOnly": true }, "identity": { "type": "string", "description": "The client id of the identity which will be used to access key vault." }, "keyRotationEnabled": { "type": "boolean", "description": "Auto key rotation status for a CMK enabled registry.", "readOnly": true }, "lastKeyRotationTimestamp": { "type": "string", "format": "date-time", "description": "Timestamp of the last successful key rotation.", "readOnly": true } } }, "LoggingProperties": { "type": "object", "description": "The logging properties of the connected registry.", "properties": { "logLevel": { "type": "string", "description": "The verbosity of logs persisted on the connected registry.", "default": "Information", "enum": [ "Debug", "Information", "Warning", "Error", "None" ], "x-ms-enum": { "name": "LogLevel", "modelAsString": true, "values": [ { "name": "Debug", "value": "Debug" }, { "name": "Information", "value": "Information" }, { "name": "Warning", "value": "Warning" }, { "name": "Error", "value": "Error" }, { "name": "None", "value": "None" } ] } }, "auditLogStatus": { "type": "string", "description": "Indicates whether audit logs are enabled on the connected registry.", "default": "Disabled", "enum": [ "Enabled", "Disabled" ], "x-ms-enum": { "name": "AuditLogStatus", "modelAsString": true, "values": [ { "name": "Enabled", "value": "Enabled" }, { "name": "Disabled", "value": "Disabled" } ] } } } }, "LoginServerProperties": { "type": "object", "description": "The login server properties of the connected registry.", "properties": { "host": { "type": "string", "description": "The host of the connected registry. Can be FQDN or IP.", "readOnly": true }, "tls": { "$ref": "#/definitions/TlsProperties", "description": "The TLS properties of the connected registry login server.", "readOnly": true } } }, "NetworkRuleSet": { "type": "object", "description": "The network rule set for a container registry.", "properties": { "defaultAction": { "type": "string", "description": "The default action of allow or deny when no other rules match.", "default": "Allow", "enum": [ "Allow", "Deny" ], "x-ms-enum": { "name": "DefaultAction", "modelAsString": true, "values": [ { "name": "Allow", "value": "Allow" }, { "name": "Deny", "value": "Deny" } ] } }, "ipRules": { "type": "array", "description": "The IP ACL rules.", "items": { "$ref": "#/definitions/IPRule" }, "x-ms-identifiers": [] } }, "required": [ "defaultAction" ] }, "OperationDefinition": { "type": "object", "description": "The definition of a container registry operation.", "properties": { "origin": { "type": "string", "description": "The origin information of the container registry operation." }, "name": { "type": "string", "description": "Operation name: {provider}/{resource}/{operation}." }, "display": { "$ref": "#/definitions/OperationDisplayDefinition", "description": "The display information for the container registry operation." }, "properties": { "$ref": "#/definitions/OperationPropertiesDefinition", "description": "The properties information for the container registry operation.", "x-ms-client-flatten": true }, "isDataAction": { "type": "boolean", "description": "This property indicates if the operation is an action or a data action\nref: https://docs.microsoft.com/en-us/azure/role-based-access-control/role-definitions#management-and-data-operations" } } }, "OperationDisplayDefinition": { "type": "object", "description": "The display information for a container registry operation.", "properties": { "provider": { "type": "string", "description": "The resource provider name: Microsoft.ContainerRegistry." }, "resource": { "type": "string", "description": "The resource on which the operation is performed." }, "operation": { "type": "string", "description": "The operation that users can perform." }, "description": { "type": "string", "description": "The description for the operation." } } }, "OperationListResult": { "type": "object", "description": "The result of a request to list container registry operations.", "properties": { "value": { "type": "array", "description": "The list of container registry operations. Since this list may be incomplete, the nextLink field should be used to request the next list of operations.", "items": { "$ref": "#/definitions/OperationDefinition" } }, "nextLink": { "type": "string", "description": "The URI that can be used to request the next list of container registry operations." } } }, "OperationLogSpecificationDefinition": { "type": "object", "description": "The definition of Azure Monitoring log.", "properties": { "name": { "type": "string", "description": "Log name." }, "displayName": { "type": "string", "description": "Log display name." }, "blobDuration": { "type": "string", "description": "Log blob duration." } } }, "OperationMetricSpecificationDefinition": { "type": "object", "description": "The definition of Azure Monitoring metric.", "properties": { "name": { "type": "string", "description": "Metric name." }, "displayName": { "type": "string", "description": "Metric display name." }, "displayDescription": { "type": "string", "description": "Metric description." }, "unit": { "type": "string", "description": "Metric unit." }, "aggregationType": { "type": "string", "description": "Metric aggregation type." }, "internalMetricName": { "type": "string", "description": "Internal metric name." } } }, "OperationPropertiesDefinition": { "type": "object", "description": "The definition of Azure Monitoring properties.", "properties": { "serviceSpecification": { "$ref": "#/definitions/OperationServiceSpecificationDefinition", "description": "The definition of Azure Monitoring service." } } }, "OperationServiceSpecificationDefinition": { "type": "object", "description": "The definition of Azure Monitoring list.", "properties": { "metricSpecifications": { "type": "array", "description": "A list of Azure Monitoring metrics definition.", "items": { "$ref": "#/definitions/OperationMetricSpecificationDefinition" }, "x-ms-identifiers": [ "name" ] }, "logSpecifications": { "type": "array", "description": "A list of Azure Monitoring log definitions.", "items": { "$ref": "#/definitions/OperationLogSpecificationDefinition" }, "x-ms-identifiers": [ "name" ] } } }, "ParentProperties": { "type": "object", "description": "The properties of the connected registry parent.", "properties": { "id": { "type": "string", "format": "arm-id", "description": "The resource ID of the parent to which the connected registry will be associated." }, "syncProperties": { "$ref": "#/definitions/SyncProperties", "description": "The sync properties of the connected registry with its parent." } }, "required": [ "syncProperties" ] }, "PasswordName": { "type": "string", "description": "The password name.", "enum": [ "password", "password2" ], "x-ms-enum": { "name": "PasswordName", "modelAsString": false } }, "Policies": { "type": "object", "description": "The policies for a container registry.", "properties": { "quarantinePolicy": { "$ref": "#/definitions/QuarantinePolicy", "description": "The quarantine policy for a container registry." }, "trustPolicy": { "$ref": "#/definitions/TrustPolicy", "description": "The content trust policy for a container registry." }, "retentionPolicy": { "$ref": "#/definitions/RetentionPolicy", "description": "The retention policy for a container registry." }, "exportPolicy": { "$ref": "#/definitions/ExportPolicy", "description": "The export policy for a container registry." }, "azureADAuthenticationAsArmPolicy": { "$ref": "#/definitions/AzureADAuthenticationAsArmPolicy", "description": "The policy for using Azure Resource Manager audience token for a container registry." } } }, "PrivateEndpoint": { "type": "object", "description": "The Private Endpoint resource.", "properties": { "id": { "type": "string", "description": "This is private endpoint resource created with Microsoft.Network resource provider." } } }, "PrivateEndpointConnection": { "type": "object", "description": "An object that represents a private endpoint connection for a container registry.", "properties": { "properties": { "$ref": "#/definitions/PrivateEndpointConnectionProperties", "description": "The properties of a private endpoint connection.", "x-ms-client-flatten": true } }, "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ProxyResource" } ] }, "PrivateEndpointConnectionListResult": { "type": "object", "description": "The result of a request to list private endpoint connections for a container registry.", "properties": { "value": { "type": "array", "description": "The list of private endpoint connections. Since this list may be incomplete, the nextLink field should be used to request the next list of private endpoint connections.", "items": { "$ref": "#/definitions/PrivateEndpointConnection" } }, "nextLink": { "type": "string", "description": "The URI that can be used to request the next list of private endpoint connections." } } }, "PrivateEndpointConnectionProperties": { "type": "object", "description": "The properties of a private endpoint connection.", "properties": { "privateEndpoint": { "$ref": "#/definitions/PrivateEndpoint", "description": "The resource of private endpoint." }, "privateLinkServiceConnectionState": { "$ref": "#/definitions/PrivateLinkServiceConnectionState", "description": "A collection of information about the state of the connection between service consumer and provider." }, "provisioningState": { "$ref": "#/definitions/ProvisioningState", "description": "The provisioning state of private endpoint connection resource.", "readOnly": true } } }, "PrivateLinkResourceListResult": { "type": "object", "description": "The result of a request to list private link resources for a container registry.", "properties": { "value": { "type": "array", "description": "The list of private link resources. Since this list may be incomplete, the nextLink field should be used to request the next list of private link resources.", "items": { "$ref": "../../../../../../common-types/resource-management/v6/privatelinks.json#/definitions/PrivateLinkResource" } }, "nextLink": { "type": "string", "description": "The URI that can be used to request the next list of private link resources." } } }, "PrivateLinkServiceConnectionState": { "type": "object", "description": "The state of a private link service connection.", "properties": { "status": { "$ref": "#/definitions/ConnectionStatus", "description": "The private link service connection status." }, "description": { "type": "string", "description": "The description for connection status. For example if connection is rejected it can indicate reason for rejection." }, "actionsRequired": { "$ref": "#/definitions/ActionsRequired", "description": "A message indicating if changes on the service provider require any updates on the consumer." } } }, "ProvisioningState": { "type": "string", "description": "The provisioning state of the archive at the time the operation was called.", "enum": [ "Creating", "Updating", "Deleting", "Succeeded", "Failed", "Canceled" ], "x-ms-enum": { "name": "ProvisioningState", "modelAsString": true, "values": [ { "name": "Creating", "value": "Creating" }, { "name": "Updating", "value": "Updating" }, { "name": "Deleting", "value": "Deleting" }, { "name": "Succeeded", "value": "Succeeded" }, { "name": "Failed", "value": "Failed" }, { "name": "Canceled", "value": "Canceled" } ] } }, "PublicNetworkAccess": { "type": "string", "description": "Whether or not public network access is allowed for the container registry.", "enum": [ "Enabled", "Disabled" ], "x-ms-enum": { "name": "PublicNetworkAccess", "modelAsString": true, "values": [ { "name": "Enabled", "value": "Enabled" }, { "name": "Disabled", "value": "Disabled" } ] } }, "QuarantinePolicy": { "type": "object", "description": "The quarantine policy for a container registry.", "properties": { "status": { "type": "string", "description": "The value that indicates whether the policy is enabled or not.", "default": "disabled", "enum": [ "enabled", "disabled" ], "x-ms-enum": { "name": "PolicyStatus", "modelAsString": true, "values": [ { "name": "enabled", "value": "enabled" }, { "name": "disabled", "value": "disabled" } ] } } } }, "RegenerateCredentialParameters": { "type": "object", "description": "The parameters used to regenerate the login credential.", "properties": { "name": { "$ref": "#/definitions/PasswordName", "description": "Specifies name of the password which should be regenerated -- password or password2." } }, "required": [ "name" ] }, "Registry": { "type": "object", "description": "An object that represents a container registry.", "properties": { "properties": { "$ref": "#/definitions/RegistryProperties", "description": "The properties of the container registry.", "x-ms-client-flatten": true }, "sku": { "$ref": "#/definitions/Sku", "description": "The SKU of the container registry." }, "identity": { "$ref": "#/definitions/IdentityProperties", "description": "The identity of the container registry." } }, "required": [ "sku" ], "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/TrackedResource" } ] }, "RegistryListCredentialsResult": { "type": "object", "description": "The response from the ListCredentials operation.", "properties": { "username": { "type": "string", "description": "The username for a container registry." }, "passwords": { "type": "array", "description": "The list of passwords for a container registry.", "items": { "$ref": "#/definitions/RegistryPassword" }, "x-ms-identifiers": [] } } }, "RegistryListResult": { "type": "object", "description": "The result of a request to list container registries.", "properties": { "value": { "type": "array", "description": "The list of container registries. Since this list may be incomplete, the nextLink field should be used to request the next list of container registries.", "items": { "$ref": "#/definitions/Registry" } }, "nextLink": { "type": "string", "description": "The URI that can be used to request the next list of container registries." } } }, "RegistryNameCheckRequest": { "type": "object", "description": "A request to check whether a container registry name is available.", "properties": { "name": { "type": "string", "description": "The name of the container registry.", "minLength": 5, "maxLength": 50, "pattern": "^[a-zA-Z0-9]*$" }, "type": { "$ref": "#/definitions/ContainerRegistryResourceType", "description": "The resource type of the container registry. This field must be set to 'Microsoft.ContainerRegistry/registries'." } }, "required": [ "name", "type" ] }, "RegistryNameStatus": { "type": "object", "description": "The result of a request to check the availability of a container registry name.", "properties": { "nameAvailable": { "type": "boolean", "description": "The value that indicates whether the name is available." }, "reason": { "type": "string", "description": "If any, the reason that the name is not available." }, "message": { "type": "string", "description": "If any, the error message that provides more detail for the reason that the name is not available." } } }, "RegistryPassword": { "type": "object", "description": "The login password for the container registry.", "properties": { "name": { "$ref": "#/definitions/PasswordName", "description": "The password name." }, "value": { "type": "string", "description": "The password value." } } }, "RegistryProperties": { "type": "object", "description": "The properties of a container registry.", "properties": { "loginServer": { "type": "string", "description": "The URL that can be used to log into the container registry.", "readOnly": true }, "creationDate": { "type": "string", "format": "date-time", "description": "The creation date of the container registry in ISO8601 format.", "readOnly": true }, "provisioningState": { "$ref": "#/definitions/ProvisioningState", "description": "The provisioning state of the container registry at the time the operation was called.", "readOnly": true }, "status": { "$ref": "#/definitions/Status", "description": "The status of the container registry at the time the operation was called.", "readOnly": true }, "adminUserEnabled": { "type": "boolean", "description": "The value that indicates whether the admin user is enabled.", "default": false }, "networkRuleSet": { "$ref": "#/definitions/NetworkRuleSet", "description": "The network rule set for a container registry." }, "policies": { "$ref": "#/definitions/Policies", "description": "The policies for a container registry." }, "encryption": { "$ref": "#/definitions/EncryptionProperty", "description": "The encryption settings of container registry." }, "dataEndpointEnabled": { "type": "boolean", "description": "Enable a single data endpoint per region for serving data." }, "dataEndpointHostNames": { "type": "array", "description": "List of host names that will serve data when dataEndpointEnabled is true.", "items": { "type": "string" }, "readOnly": true }, "privateEndpointConnections": { "type": "array", "description": "List of private endpoint connections for a container registry.", "items": { "$ref": "#/definitions/PrivateEndpointConnection" }, "readOnly": true }, "publicNetworkAccess": { "type": "string", "description": "Whether or not public network access is allowed for the container registry.", "default": "Enabled", "enum": [ "Enabled", "Disabled" ], "x-ms-enum": { "name": "PublicNetworkAccess", "modelAsString": true, "values": [ { "name": "Enabled", "value": "Enabled" }, { "name": "Disabled", "value": "Disabled" } ] } }, "networkRuleBypassOptions": { "type": "string", "description": "Whether to allow trusted Azure services to access a network restricted registry.", "default": "AzureServices", "enum": [ "AzureServices", "None" ], "x-ms-enum": { "name": "NetworkRuleBypassOptions", "modelAsString": true, "values": [ { "name": "AzureServices", "value": "AzureServices" }, { "name": "None", "value": "None" } ] } }, "networkRuleBypassAllowedForTasks": { "type": "boolean", "description": "Whether or not Tasks allowed to bypass the network rules for this container registry.", "default": false }, "zoneRedundancy": { "type": "string", "description": "Whether or not zone redundancy is enabled for this container registry", "default": "Disabled", "enum": [ "Enabled", "Disabled" ], "x-ms-enum": { "name": "ZoneRedundancy", "modelAsString": true, "values": [ { "name": "Enabled", "value": "Enabled" }, { "name": "Disabled", "value": "Disabled" } ] } }, "anonymousPullEnabled": { "type": "boolean", "description": "Enables registry-wide pull from unauthenticated clients.", "default": false }, "roleAssignmentMode": { "type": "string", "description": "Determines registry role assignment mode.", "default": "LegacyRegistryPermissions", "enum": [ "AbacRepositoryPermissions", "LegacyRegistryPermissions" ], "x-ms-enum": { "name": "RoleAssignmentMode", "modelAsString": true, "values": [ { "name": "AbacRepositoryPermissions", "value": "AbacRepositoryPermissions" }, { "name": "LegacyRegistryPermissions", "value": "LegacyRegistryPermissions" } ] } } } }, "RegistryPropertiesUpdateParameters": { "type": "object", "description": "The parameters for updating the properties of a container registry.", "properties": { "adminUserEnabled": { "type": "boolean", "description": "The value that indicates whether the admin user is enabled." }, "networkRuleSet": { "$ref": "#/definitions/NetworkRuleSet", "description": "The network rule set for a container registry." }, "policies": { "$ref": "#/definitions/Policies", "description": "The policies for a container registry." }, "encryption": { "$ref": "#/definitions/EncryptionProperty", "description": "The encryption settings of container registry." }, "dataEndpointEnabled": { "type": "boolean", "description": "Enable a single data endpoint per region for serving data." }, "publicNetworkAccess": { "$ref": "#/definitions/PublicNetworkAccess", "description": "Whether or not public network access is allowed for the container registry." }, "networkRuleBypassOptions": { "type": "string", "description": "Whether to allow trusted Azure services to access a network restricted registry.", "default": "AzureServices", "enum": [ "AzureServices", "None" ], "x-ms-enum": { "name": "NetworkRuleBypassOptions", "modelAsString": true, "values": [ { "name": "AzureServices", "value": "AzureServices" }, { "name": "None", "value": "None" } ] } }, "networkRuleBypassAllowedForTasks": { "type": "boolean", "description": "Whether to allow ACR Tasks service to access a network restricted registry." }, "anonymousPullEnabled": { "type": "boolean", "description": "Enables registry-wide pull from unauthenticated clients." }, "roleAssignmentMode": { "$ref": "#/definitions/RoleAssignmentMode", "description": "Determines registry role assignment mode." } } }, "RegistryUpdateParameters": { "type": "object", "description": "The parameters for updating a container registry.", "properties": { "identity": { "$ref": "#/definitions/IdentityProperties", "description": "The identity of the container registry." }, "tags": { "type": "object", "description": "The tags for the container registry.", "additionalProperties": { "type": "string" } }, "sku": { "$ref": "#/definitions/Sku", "description": "The SKU of the container registry." }, "properties": { "$ref": "#/definitions/RegistryPropertiesUpdateParameters", "description": "The properties that the container registry will be updated with.", "x-ms-client-flatten": true } } }, "RegistryUsage": { "type": "object", "description": "The quota usage for a container registry.", "properties": { "name": { "type": "string", "description": "The name of the usage." }, "limit": { "type": "integer", "format": "int64", "description": "The limit of the usage." }, "currentValue": { "type": "integer", "format": "int64", "description": "The current value of the usage." }, "unit": { "$ref": "#/definitions/RegistryUsageUnit", "description": "The unit of measurement." } } }, "RegistryUsageListResult": { "type": "object", "description": "The result of a request to get container registry quota usages.", "properties": { "value": { "type": "array", "description": "The list of container registry quota usages.", "items": { "$ref": "#/definitions/RegistryUsage" }, "x-ms-identifiers": [ "name" ] } } }, "RegistryUsageUnit": { "type": "string", "description": "The unit of measurement.", "enum": [ "Count", "Bytes" ], "x-ms-enum": { "name": "RegistryUsageUnit", "modelAsString": true, "values": [ { "name": "Count", "value": "Count" }, { "name": "Bytes", "value": "Bytes" } ] } }, "Replication": { "type": "object", "description": "An object that represents a replication for a container registry.", "properties": { "properties": { "$ref": "#/definitions/ReplicationProperties", "description": "The properties of the replication.", "x-ms-client-flatten": true } }, "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/TrackedResource" } ] }, "ReplicationListResult": { "type": "object", "description": "The result of a request to list replications for a container registry.", "properties": { "value": { "type": "array", "description": "The list of replications. Since this list may be incomplete, the nextLink field should be used to request the next list of replications.", "items": { "$ref": "#/definitions/Replication" } }, "nextLink": { "type": "string", "description": "The URI that can be used to request the next list of replications." } } }, "ReplicationProperties": { "type": "object", "description": "The properties of a replication.", "properties": { "provisioningState": { "$ref": "#/definitions/ProvisioningState", "description": "The provisioning state of the replication at the time the operation was called.", "readOnly": true }, "status": { "$ref": "#/definitions/Status", "description": "The status of the replication at the time the operation was called.", "readOnly": true }, "regionEndpointEnabled": { "type": "boolean", "description": "Specifies whether the replication's regional endpoint is enabled. Requests will not be routed to a replication whose regional endpoint is disabled, however its data will continue to be synced with other replications.", "default": true }, "zoneRedundancy": { "type": "string", "description": "Whether or not zone redundancy is enabled for this container registry replication", "default": "Disabled", "enum": [ "Enabled", "Disabled" ], "x-ms-enum": { "name": "ZoneRedundancy", "modelAsString": true, "values": [ { "name": "Enabled", "value": "Enabled" }, { "name": "Disabled", "value": "Disabled" } ] } } } }, "ReplicationUpdateParameters": { "type": "object", "description": "The parameters for updating a replication.", "properties": { "tags": { "type": "object", "description": "The tags for the replication.", "additionalProperties": { "type": "string" } }, "properties": { "$ref": "#/definitions/ReplicationUpdateParametersProperties", "description": "The parameters for updating a replication's properties", "x-ms-client-flatten": true } } }, "ReplicationUpdateParametersProperties": { "type": "object", "properties": { "regionEndpointEnabled": { "type": "boolean", "description": "Specifies whether the replication's regional endpoint is enabled. Requests will not be routed to a replication whose regional endpoint is disabled, however its data will continue to be synced with other replications." } } }, "Request": { "type": "object", "description": "The request that generated the event.", "properties": { "id": { "type": "string", "description": "The ID of the request that initiated the event." }, "addr": { "type": "string", "description": "The IP or hostname and possibly port of the client connection that initiated the event. This is the RemoteAddr from the standard http request." }, "host": { "type": "string", "description": "The externally accessible hostname of the registry instance, as specified by the http host header on incoming requests." }, "method": { "type": "string", "description": "The request method that generated the event." }, "useragent": { "type": "string", "description": "The user agent header of the request." } } }, "ResourceIdentityType": { "type": "string", "description": "The identity type.", "enum": [ "SystemAssigned", "UserAssigned", "SystemAssigned, UserAssigned", "None" ], "x-ms-enum": { "name": "ResourceIdentityType", "modelAsString": false } }, "RetentionPolicy": { "type": "object", "description": "The retention policy for a container registry.", "properties": { "days": { "type": "integer", "format": "int32", "description": "The number of days to retain an untagged manifest after which it gets purged.", "default": 7 }, "lastUpdatedTime": { "type": "string", "format": "date-time", "description": "The timestamp when the policy was last updated.", "readOnly": true }, "status": { "type": "string", "description": "The value that indicates whether the policy is enabled or not.", "default": "disabled", "enum": [ "enabled", "disabled" ], "x-ms-enum": { "name": "PolicyStatus", "modelAsString": true, "values": [ { "name": "enabled", "value": "enabled" }, { "name": "disabled", "value": "disabled" } ] } } } }, "RoleAssignmentMode": { "type": "string", "description": "Determines registry role assignment mode.", "enum": [ "AbacRepositoryPermissions", "LegacyRegistryPermissions" ], "x-ms-enum": { "name": "RoleAssignmentMode", "modelAsString": true, "values": [ { "name": "AbacRepositoryPermissions", "value": "AbacRepositoryPermissions" }, { "name": "LegacyRegistryPermissions", "value": "LegacyRegistryPermissions" } ] } }, "ScopeMap": { "type": "object", "description": "An object that represents a scope map for a container registry.", "properties": { "properties": { "$ref": "#/definitions/ScopeMapProperties", "description": "The properties of the scope map.", "x-ms-client-flatten": true } }, "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ProxyResource" } ] }, "ScopeMapListResult": { "type": "object", "description": "The result of a request to list scope maps for a container registry.", "properties": { "value": { "type": "array", "description": "The list of scope maps. Since this list may be incomplete, the nextLink field should be used to request the next list of scope maps.", "items": { "$ref": "#/definitions/ScopeMap" } }, "nextLink": { "type": "string", "description": "The URI that can be used to request the next list of scope maps." } } }, "ScopeMapProperties": { "type": "object", "description": "The properties of a scope map.", "properties": { "description": { "type": "string", "description": "The user friendly description of the scope map." }, "type": { "type": "string", "description": "The type of the scope map. E.g. BuildIn scope map.", "readOnly": true }, "creationDate": { "type": "string", "format": "date-time", "description": "The creation date of scope map.", "readOnly": true }, "provisioningState": { "$ref": "#/definitions/ProvisioningState", "description": "Provisioning state of the resource.", "readOnly": true }, "actions": { "type": "array", "description": "The list of scoped permissions for registry artifacts.\nE.g. repositories/repository-name/content/read,\nrepositories/repository-name/metadata/write", "items": { "type": "string" } } }, "required": [ "actions" ] }, "ScopeMapPropertiesUpdateParameters": { "type": "object", "description": "The update parameters for scope map properties.", "properties": { "description": { "type": "string", "description": "The user friendly description of the scope map." }, "actions": { "type": "array", "description": "The list of scope permissions for registry artifacts.\nE.g. repositories/repository-name/pull,\nrepositories/repository-name/delete", "items": { "type": "string" } } } }, "ScopeMapUpdateParameters": { "type": "object", "description": "The properties for updating the scope map.", "properties": { "properties": { "$ref": "#/definitions/ScopeMapPropertiesUpdateParameters", "description": "The update parameters for scope map properties.", "x-ms-client-flatten": true } } }, "Sku": { "type": "object", "description": "The SKU of a container registry.", "properties": { "name": { "$ref": "#/definitions/SkuName", "description": "The SKU name of the container registry. Required for registry creation." }, "tier": { "$ref": "#/definitions/SkuTier", "description": "The SKU tier based on the SKU name.", "readOnly": true } }, "required": [ "name" ] }, "SkuName": { "type": "string", "description": "The SKU name of the container registry. Required for registry creation.", "enum": [ "Classic", "Basic", "Standard", "Premium" ], "x-ms-enum": { "name": "SkuName", "modelAsString": true, "values": [ { "name": "Classic", "value": "Classic" }, { "name": "Basic", "value": "Basic" }, { "name": "Standard", "value": "Standard" }, { "name": "Premium", "value": "Premium" } ] } }, "SkuTier": { "type": "string", "description": "The SKU tier based on the SKU name.", "enum": [ "Classic", "Basic", "Standard", "Premium" ], "x-ms-enum": { "name": "SkuTier", "modelAsString": true, "values": [ { "name": "Classic", "value": "Classic" }, { "name": "Basic", "value": "Basic" }, { "name": "Standard", "value": "Standard" }, { "name": "Premium", "value": "Premium" } ] } }, "Source": { "type": "object", "description": "The registry node that generated the event. Put differently, while the actor initiates the event, the source generates it.", "properties": { "addr": { "type": "string", "description": "The IP or hostname and the port of the registry node that generated the event. Generally, this will be resolved by os.Hostname() along with the running port." }, "instanceID": { "type": "string", "description": "The running instance of an application. Changes after each restart." } } }, "Status": { "type": "object", "description": "The status of an Azure resource at the time the operation was called.", "properties": { "displayStatus": { "type": "string", "description": "The short label for the status.", "readOnly": true }, "message": { "type": "string", "description": "The detailed message for the status, including alerts and error messages.", "readOnly": true }, "timestamp": { "type": "string", "format": "date-time", "description": "The timestamp when the status was changed to the current value.", "readOnly": true } } }, "StatusDetailProperties": { "type": "object", "description": "The status detail properties of the connected registry.", "properties": { "type": { "type": "string", "description": "The component of the connected registry corresponding to the status.", "readOnly": true }, "code": { "type": "string", "description": "The HTTP status code.", "readOnly": true }, "description": { "type": "string", "description": "The description of the status.", "readOnly": true }, "timestamp": { "type": "string", "format": "date-time", "description": "The timestamp of the status.", "readOnly": true }, "correlationId": { "type": "string", "description": "The correlation ID of the status.", "readOnly": true } } }, "SyncProperties": { "type": "object", "description": "The sync properties of the connected registry with its parent.", "properties": { "tokenId": { "type": "string", "description": "The resource ID of the ACR token used to authenticate the connected registry to its parent during sync." }, "schedule": { "type": "string", "description": "The cron expression indicating the schedule that the connected registry will sync with its parent." }, "syncWindow": { "type": "string", "format": "duration", "description": "The time window during which sync is enabled for each schedule occurrence. Specify the duration using the format P[n]Y[n]M[n]DT[n]H[n]M[n]S as per ISO8601." }, "messageTtl": { "type": "string", "format": "duration", "description": "The period of time for which a message is available to sync before it is expired. Specify the duration using the format P[n]Y[n]M[n]DT[n]H[n]M[n]S as per ISO8601." }, "lastSyncTime": { "type": "string", "format": "date-time", "description": "The last time a sync occurred between the connected registry and its parent.", "readOnly": true }, "gatewayEndpoint": { "type": "string", "description": "The gateway endpoint used by the connected registry to communicate with its parent.", "readOnly": true } }, "required": [ "tokenId", "messageTtl" ] }, "SyncUpdateProperties": { "type": "object", "description": "The parameters for updating the sync properties of the connected registry with its parent.", "properties": { "schedule": { "type": "string", "description": "The cron expression indicating the schedule that the connected registry will sync with its parent." }, "syncWindow": { "type": "string", "format": "duration", "description": "The time window during which sync is enabled for each schedule occurrence. Specify the duration using the format P[n]Y[n]M[n]DT[n]H[n]M[n]S as per ISO8601." }, "messageTtl": { "type": "string", "format": "duration", "description": "The period of time for which a message is available to sync before it is expired. Specify the duration using the format P[n]Y[n]M[n]DT[n]H[n]M[n]S as per ISO8601." } } }, "Target": { "type": "object", "description": "The target of the event.", "properties": { "mediaType": { "type": "string", "description": "The MIME type of the referenced object." }, "size": { "type": "integer", "format": "int64", "description": "The number of bytes of the content. Same as Length field." }, "digest": { "type": "string", "description": "The digest of the content, as defined by the Registry V2 HTTP API Specification." }, "length": { "type": "integer", "format": "int64", "description": "The number of bytes of the content. Same as Size field." }, "repository": { "type": "string", "description": "The repository name." }, "url": { "type": "string", "description": "The direct URL to the content." }, "tag": { "type": "string", "description": "The tag name." }, "name": { "type": "string", "description": "The name of the artifact." }, "version": { "type": "string", "description": "The version of the artifact." } } }, "TlsCertificateProperties": { "type": "object", "description": "The TLS certificate properties of the connected registry login server.", "properties": { "type": { "$ref": "#/definitions/CertificateType", "description": "The type of certificate location.", "readOnly": true }, "location": { "type": "string", "description": "Indicates the location of the certificates.", "readOnly": true } } }, "TlsProperties": { "type": "object", "description": "The TLS properties of the connected registry login server.", "properties": { "status": { "$ref": "#/definitions/TlsStatus", "description": "Indicates whether HTTPS is enabled for the login server.", "readOnly": true }, "certificate": { "$ref": "#/definitions/TlsCertificateProperties", "description": "The certificate used to configure HTTPS for the login server.", "readOnly": true } } }, "TlsStatus": { "type": "string", "description": "Indicates whether HTTPS is enabled for the login server.", "enum": [ "Enabled", "Disabled" ], "x-ms-enum": { "name": "TlsStatus", "modelAsString": true, "values": [ { "name": "Enabled", "value": "Enabled" }, { "name": "Disabled", "value": "Disabled" } ] } }, "Token": { "type": "object", "description": "An object that represents a token for a container registry.", "properties": { "properties": { "$ref": "#/definitions/TokenProperties", "description": "The properties of the token.", "x-ms-client-flatten": true } }, "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ProxyResource" } ] }, "TokenCertificate": { "type": "object", "description": "The properties of a certificate used for authenticating a token.", "properties": { "name": { "$ref": "#/definitions/TokenCertificateName" }, "expiry": { "type": "string", "format": "date-time", "description": "The expiry datetime of the certificate." }, "thumbprint": { "type": "string", "description": "The thumbprint of the certificate." }, "encodedPemCertificate": { "type": "string", "description": "Base 64 encoded string of the public certificate1 in PEM format that will be used for authenticating the token." } } }, "TokenCertificateName": { "type": "string", "enum": [ "certificate1", "certificate2" ], "x-ms-enum": { "name": "TokenCertificateName", "modelAsString": true, "values": [ { "name": "certificate1", "value": "certificate1" }, { "name": "certificate2", "value": "certificate2" } ] } }, "TokenCredentialsProperties": { "type": "object", "description": "The properties of the credentials that can be used for authenticating the token.", "properties": { "certificates": { "type": "array", "items": { "$ref": "#/definitions/TokenCertificate" }, "x-ms-identifiers": [ "thumbprint" ] }, "passwords": { "type": "array", "items": { "$ref": "#/definitions/TokenPassword" }, "x-ms-identifiers": [] } } }, "TokenListResult": { "type": "object", "description": "The result of a request to list tokens for a container registry.", "properties": { "value": { "type": "array", "description": "The list of tokens. Since this list may be incomplete, the nextLink field should be used to request the next list of tokens.", "items": { "$ref": "#/definitions/Token" } }, "nextLink": { "type": "string", "description": "The URI that can be used to request the next list of tokens." } } }, "TokenPassword": { "type": "object", "description": "The password that will be used for authenticating the token of a container registry.", "properties": { "creationTime": { "type": "string", "format": "date-time", "description": "The creation datetime of the password." }, "expiry": { "type": "string", "format": "date-time", "description": "The expiry datetime of the password." }, "name": { "$ref": "#/definitions/TokenPasswordName", "description": "The password name \"password1\" or \"password2\"" }, "value": { "type": "string", "description": "The password value.", "readOnly": true } } }, "TokenPasswordName": { "type": "string", "description": "The password name \"password1\" or \"password2\"", "enum": [ "password1", "password2" ], "x-ms-enum": { "name": "TokenPasswordName", "modelAsString": true, "values": [ { "name": "password1", "value": "password1" }, { "name": "password2", "value": "password2" } ] } }, "TokenProperties": { "type": "object", "description": "The properties of a token.", "properties": { "creationDate": { "type": "string", "format": "date-time", "description": "The creation date of scope map.", "readOnly": true }, "provisioningState": { "$ref": "#/definitions/ProvisioningState", "description": "Provisioning state of the resource.", "readOnly": true }, "scopeMapId": { "type": "string", "description": "The resource ID of the scope map to which the token will be associated with." }, "credentials": { "$ref": "#/definitions/TokenCredentialsProperties", "description": "The credentials that can be used for authenticating the token." }, "status": { "$ref": "#/definitions/TokenStatus", "description": "The status of the token example enabled or disabled." } } }, "TokenStatus": { "type": "string", "description": "The status of the token example enabled or disabled.", "enum": [ "enabled", "disabled" ], "x-ms-enum": { "name": "TokenStatus", "modelAsString": true, "values": [ { "name": "enabled", "value": "enabled" }, { "name": "disabled", "value": "disabled" } ] } }, "TokenUpdateParameters": { "type": "object", "description": "The parameters for updating a token.", "properties": { "properties": { "$ref": "#/definitions/TokenUpdateProperties", "description": "The properties of the token update parameters.", "x-ms-client-flatten": true } } }, "TokenUpdateProperties": { "type": "object", "description": "The parameters for updating token properties.", "properties": { "scopeMapId": { "type": "string", "description": "The resource ID of the scope map to which the token will be associated with." }, "status": { "$ref": "#/definitions/TokenStatus", "description": "The status of the token example enabled or disabled." }, "credentials": { "$ref": "#/definitions/TokenCredentialsProperties", "description": "The credentials that can be used for authenticating the token." } } }, "TrustPolicy": { "type": "object", "description": "The content trust policy for a container registry.", "properties": { "type": { "type": "string", "description": "The type of trust policy.", "default": "Notary", "enum": [ "Notary" ], "x-ms-enum": { "name": "TrustPolicyType", "modelAsString": true, "values": [ { "name": "Notary", "value": "Notary" } ] } }, "status": { "type": "string", "description": "The value that indicates whether the policy is enabled or not.", "default": "disabled", "enum": [ "enabled", "disabled" ], "x-ms-enum": { "name": "PolicyStatus", "modelAsString": true, "values": [ { "name": "enabled", "value": "enabled" }, { "name": "disabled", "value": "disabled" } ] } } } }, "UserIdentityProperties": { "type": "object", "properties": { "principalId": { "type": "string", "description": "The principal id of user assigned identity.", "readOnly": true }, "clientId": { "type": "string", "description": "The client id of user assigned identity.", "readOnly": true } } }, "Webhook": { "type": "object", "description": "An object that represents a webhook for a container registry.", "properties": { "properties": { "$ref": "#/definitions/WebhookProperties", "description": "The properties of the webhook.", "x-ms-client-flatten": true } }, "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/TrackedResource" } ] }, "WebhookAction": { "type": "string", "enum": [ "push", "delete", "quarantine", "chart_push", "chart_delete" ], "x-ms-enum": { "name": "WebhookAction", "modelAsString": true, "values": [ { "name": "push", "value": "push" }, { "name": "delete", "value": "delete" }, { "name": "quarantine", "value": "quarantine" }, { "name": "chart_push", "value": "chart_push" }, { "name": "chart_delete", "value": "chart_delete" } ] } }, "WebhookCreateParameters": { "type": "object", "description": "The parameters for creating a webhook.", "properties": { "tags": { "type": "object", "description": "The tags for the webhook.", "additionalProperties": { "type": "string" } }, "location": { "type": "string", "description": "The location of the webhook. This cannot be changed after the resource is created." }, "properties": { "$ref": "#/definitions/WebhookPropertiesCreateParameters", "description": "The properties that the webhook will be created with.", "x-ms-client-flatten": true } }, "required": [ "location" ] }, "WebhookListResult": { "type": "object", "description": "The result of a request to list webhooks for a container registry.", "properties": { "value": { "type": "array", "description": "The list of webhooks. Since this list may be incomplete, the nextLink field should be used to request the next list of webhooks.", "items": { "$ref": "#/definitions/Webhook" } }, "nextLink": { "type": "string", "description": "The URI that can be used to request the next list of webhooks." } } }, "WebhookProperties": { "type": "object", "description": "The properties of a webhook.", "properties": { "status": { "$ref": "#/definitions/WebhookStatus", "description": "The status of the webhook at the time the operation was called." }, "scope": { "type": "string", "description": "The scope of repositories where the event can be triggered. For example, 'foo:*' means events for all tags under repository 'foo'. 'foo:bar' means events for 'foo:bar' only. 'foo' is equivalent to 'foo:latest'. Empty means all events." }, "actions": { "type": "array", "description": "The list of actions that trigger the webhook to post notifications.", "items": { "$ref": "#/definitions/WebhookAction" } }, "provisioningState": { "$ref": "#/definitions/ProvisioningState", "description": "The provisioning state of the webhook at the time the operation was called.", "readOnly": true } }, "required": [ "actions" ] }, "WebhookPropertiesCreateParameters": { "type": "object", "description": "The parameters for creating the properties of a webhook.", "properties": { "serviceUri": { "type": "string", "format": "password", "description": "The service URI for the webhook to post notifications.", "x-ms-secret": true }, "customHeaders": { "type": "object", "format": "password", "description": "Custom headers that will be added to the webhook notifications.", "additionalProperties": { "type": "string" }, "x-ms-secret": true }, "status": { "$ref": "#/definitions/WebhookStatus", "description": "The status of the webhook at the time the operation was called." }, "scope": { "type": "string", "description": "The scope of repositories where the event can be triggered. For example, 'foo:*' means events for all tags under repository 'foo'. 'foo:bar' means events for 'foo:bar' only. 'foo' is equivalent to 'foo:latest'. Empty means all events." }, "actions": { "type": "array", "description": "The list of actions that trigger the webhook to post notifications.", "items": { "$ref": "#/definitions/WebhookAction" } } }, "required": [ "serviceUri", "actions" ] }, "WebhookPropertiesUpdateParameters": { "type": "object", "description": "The parameters for updating the properties of a webhook.", "properties": { "serviceUri": { "type": "string", "format": "password", "description": "The service URI for the webhook to post notifications.", "x-ms-secret": true }, "customHeaders": { "type": "object", "format": "password", "description": "Custom headers that will be added to the webhook notifications.", "additionalProperties": { "type": "string" }, "x-ms-secret": true }, "status": { "$ref": "#/definitions/WebhookStatus", "description": "The status of the webhook at the time the operation was called." }, "scope": { "type": "string", "description": "The scope of repositories where the event can be triggered. For example, 'foo:*' means events for all tags under repository 'foo'. 'foo:bar' means events for 'foo:bar' only. 'foo' is equivalent to 'foo:latest'. Empty means all events." }, "actions": { "type": "array", "description": "The list of actions that trigger the webhook to post notifications.", "items": { "$ref": "#/definitions/WebhookAction" } } } }, "WebhookStatus": { "type": "string", "description": "The status of the webhook at the time the operation was called.", "enum": [ "enabled", "disabled" ], "x-ms-enum": { "name": "WebhookStatus", "modelAsString": true, "values": [ { "name": "enabled", "value": "enabled" }, { "name": "disabled", "value": "disabled" } ] } }, "WebhookUpdateParameters": { "type": "object", "description": "The parameters for updating a webhook.", "properties": { "tags": { "type": "object", "description": "The tags for the webhook.", "additionalProperties": { "type": "string" } }, "properties": { "$ref": "#/definitions/WebhookPropertiesUpdateParameters", "description": "The properties that the webhook will be updated with.", "x-ms-client-flatten": true } } } }, "parameters": {} }