Microsoft.ContainerRegistry (preview:2019-05-01)

2025/09/04 • 11 new, 11 deleted methods

ScopeMaps_Get (new)
Description :  Gets the properties of the specified scope map.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/scopeMaps/{scopeMapName}
{
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group to which the container registry belongs. ,
Required: True ,
}
string ,
registryName:
{
Description: The name of the container registry. ,
Required: True ,
}
string ,
scopeMapName:
{
Description: The name of the scope map. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the scope map. ,
Required: False ,
}
{
description:
{
Description: The user friendly description of the scope map. ,
Required: False ,
}
string ,
type:
{
Description: The type of the scope map. E.g. BuildIn scope map. ,
Required: False ,
}
string ,
creationDate:
{
Description: The creation date of scope map. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
actions:
{
Description: The list of scoped permissions for registry artifacts. E.g. repositories/repository-name/content/read, repositories/repository-name/metadata/write ,
Required: True ,
}
[
string ,
]
,
}
,
}
ScopeMaps_Create (new)
Description :  Creates a scope map for a container registry with the specified parameters.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/scopeMaps/{scopeMapName}
{
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group to which the container registry belongs. ,
Required: True ,
}
string ,
registryName:
{
Description: The name of the container registry. ,
Required: True ,
}
string ,
scopeMapName:
{
Description: The name of the scope map. ,
Required: True ,
}
string ,
scopeMapCreateParameters:
{
Description: The parameters for creating a scope map. ,
Required: True ,
}
{
properties:
{
Description: The properties of the scope map. ,
Required: False ,
}
{
description:
{
Description: The user friendly description of the scope map. ,
Required: False ,
}
string ,
type:
{
Description: The type of the scope map. E.g. BuildIn scope map. ,
Required: False ,
}
string ,
creationDate:
{
Description: The creation date of scope map. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
actions:
{
Description: The list of scoped permissions for registry artifacts. E.g. repositories/repository-name/content/read, repositories/repository-name/metadata/write ,
Required: True ,
}
[
string ,
]
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the scope map. ,
Required: False ,
}
{
description:
{
Description: The user friendly description of the scope map. ,
Required: False ,
}
string ,
type:
{
Description: The type of the scope map. E.g. BuildIn scope map. ,
Required: False ,
}
string ,
creationDate:
{
Description: The creation date of scope map. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
actions:
{
Description: The list of scoped permissions for registry artifacts. E.g. repositories/repository-name/content/read, repositories/repository-name/metadata/write ,
Required: True ,
}
[
string ,
]
,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The properties of the scope map. ,
Required: False ,
}
{
description:
{
Description: The user friendly description of the scope map. ,
Required: False ,
}
string ,
type:
{
Description: The type of the scope map. E.g. BuildIn scope map. ,
Required: False ,
}
string ,
creationDate:
{
Description: The creation date of scope map. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
actions:
{
Description: The list of scoped permissions for registry artifacts. E.g. repositories/repository-name/content/read, repositories/repository-name/metadata/write ,
Required: True ,
}
[
string ,
]
,
}
,
}
ScopeMaps_Delete (new)
Description :  Deletes a scope map from a container registry.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/scopeMaps/{scopeMapName}
{
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group to which the container registry belongs. ,
Required: True ,
}
string ,
registryName:
{
Description: The name of the container registry. ,
Required: True ,
}
string ,
scopeMapName:
{
Description: The name of the scope map. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}
ScopeMaps_Update (new)
Description :  Updates a scope map with the specified parameters.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/scopeMaps/{scopeMapName}
{
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group to which the container registry belongs. ,
Required: True ,
}
string ,
registryName:
{
Description: The name of the container registry. ,
Required: True ,
}
string ,
scopeMapName:
{
Description: The name of the scope map. ,
Required: True ,
}
string ,
scopeMapUpdateParameters:
{
Description: The parameters for updating a scope map. ,
Required: True ,
}
{
properties:
{
Description: The update parameters for scope map properties. ,
Required: False ,
}
{
description:
{
Description: The user friendly description of the scope map. ,
Required: False ,
}
string ,
actions:
{
Description: The list of scope permissions for registry artifacts. E.g. repositories/repository-name/pull, repositories/repository-name/delete ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the scope map. ,
Required: False ,
}
{
description:
{
Description: The user friendly description of the scope map. ,
Required: False ,
}
string ,
type:
{
Description: The type of the scope map. E.g. BuildIn scope map. ,
Required: False ,
}
string ,
creationDate:
{
Description: The creation date of scope map. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
actions:
{
Description: The list of scoped permissions for registry artifacts. E.g. repositories/repository-name/content/read, repositories/repository-name/metadata/write ,
Required: True ,
}
[
string ,
]
,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The properties of the scope map. ,
Required: False ,
}
{
description:
{
Description: The user friendly description of the scope map. ,
Required: False ,
}
string ,
type:
{
Description: The type of the scope map. E.g. BuildIn scope map. ,
Required: False ,
}
string ,
creationDate:
{
Description: The creation date of scope map. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
actions:
{
Description: The list of scoped permissions for registry artifacts. E.g. repositories/repository-name/content/read, repositories/repository-name/metadata/write ,
Required: True ,
}
[
string ,
]
,
}
,
}
ScopeMaps_List (new)
Description :  Lists all the scope maps for the specified container registry.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/scopeMaps
{
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group to which the container registry belongs. ,
Required: True ,
}
string ,
registryName:
{
Description: The name of the container registry. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
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. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the scope map. ,
Required: False ,
}
{
description:
{
Description: The user friendly description of the scope map. ,
Required: False ,
}
string ,
type:
{
Description: The type of the scope map. E.g. BuildIn scope map. ,
Required: False ,
}
string ,
creationDate:
{
Description: The creation date of scope map. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
actions:
{
Description: The list of scoped permissions for registry artifacts. E.g. repositories/repository-name/content/read, repositories/repository-name/metadata/write ,
Required: True ,
}
[
string ,
]
,
}
,
}
,
]
,
nextLink:
{
Description: The URI that can be used to request the next list of scope maps. ,
Required: False ,
}
string ,
}
Tokens_Get (new)
Description :  Gets the properties of the specified token.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/tokens/{tokenName}
{
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group to which the container registry belongs. ,
Required: True ,
}
string ,
registryName:
{
Description: The name of the container registry. ,
Required: True ,
}
string ,
tokenName:
{
Description: The name of the token. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the token. ,
Required: False ,
}
{
creationDate:
{
Description: The creation date of scope map. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
scopeMapId:
{
Description: The resource ID of the scope map to which the token will be associated with. ,
Required: False ,
}
string ,
credentials:
{
Description: The credentials that can be used for authenticating the token. ,
Required: False ,
}
{
activeDirectoryObject:
{
Description: The Active Directory Object that will be used for authenticating the token of a container registry. ,
Required: False ,
}
{
objectId:
{
Description: The user/group/application object ID for Active Directory Object that will be used for authenticating the token of a container registry. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of user/group/application object Active Directory Object that will be used for authenticating the token of a container registry. ,
Required: False ,
}
string ,
}
,
certificates:
{
Required: False ,
}
[
{
name:
{
Enum:
{
certificate1: No description available. ,
certificate2: No description available. ,
}
,
Required: False ,
}
enum ,
expiry:
{
Description: The expiry datetime of the certificate. ,
Format: date-time ,
Required: False ,
}
string ,
thumbprint:
{
Description: The thumbprint of the certificate. ,
Required: False ,
}
string ,
encodedPemCertificate:
{
Description: Base 64 encoded string of the public certificate1 in PEM format that will be used for authenticating the token. ,
Required: False ,
}
string ,
}
,
]
,
passwords:
{
Required: False ,
}
[
{
creationTime:
{
Description: The creation datetime of the password. ,
Format: date-time ,
Required: False ,
}
string ,
expiry:
{
Description: The expiry datetime of the password. ,
Format: date-time ,
Required: False ,
}
string ,
name:
{
Description: The password name "password1" or "password2" ,
Enum:
{
password1: No description available. ,
password2: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The password value. ,
Required: False ,
}
string ,
}
,
]
,
}
,
status:
{
Description: The status of the token example enabled or disabled. ,
Enum:
{
enabled: No description available. ,
disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
Tokens_Create (new)
Description :  Creates a token for a container registry with the specified parameters.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/tokens/{tokenName}
{
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group to which the container registry belongs. ,
Required: True ,
}
string ,
registryName:
{
Description: The name of the container registry. ,
Required: True ,
}
string ,
tokenName:
{
Description: The name of the token. ,
Required: True ,
}
string ,
tokenCreateParameters:
{
Description: The parameters for creating a token. ,
Required: True ,
}
{
properties:
{
Description: The properties of the token. ,
Required: False ,
}
{
creationDate:
{
Description: The creation date of scope map. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
scopeMapId:
{
Description: The resource ID of the scope map to which the token will be associated with. ,
Required: False ,
}
string ,
credentials:
{
Description: The credentials that can be used for authenticating the token. ,
Required: False ,
}
{
activeDirectoryObject:
{
Description: The Active Directory Object that will be used for authenticating the token of a container registry. ,
Required: False ,
}
{
objectId:
{
Description: The user/group/application object ID for Active Directory Object that will be used for authenticating the token of a container registry. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of user/group/application object Active Directory Object that will be used for authenticating the token of a container registry. ,
Required: False ,
}
string ,
}
,
certificates:
{
Required: False ,
}
[
{
name:
{
Enum:
{
certificate1: No description available. ,
certificate2: No description available. ,
}
,
Required: False ,
}
enum ,
expiry:
{
Description: The expiry datetime of the certificate. ,
Format: date-time ,
Required: False ,
}
string ,
thumbprint:
{
Description: The thumbprint of the certificate. ,
Required: False ,
}
string ,
encodedPemCertificate:
{
Description: Base 64 encoded string of the public certificate1 in PEM format that will be used for authenticating the token. ,
Required: False ,
}
string ,
}
,
]
,
passwords:
{
Required: False ,
}
[
{
creationTime:
{
Description: The creation datetime of the password. ,
Format: date-time ,
Required: False ,
}
string ,
expiry:
{
Description: The expiry datetime of the password. ,
Format: date-time ,
Required: False ,
}
string ,
name:
{
Description: The password name "password1" or "password2" ,
Enum:
{
password1: No description available. ,
password2: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The password value. ,
Required: False ,
}
string ,
}
,
]
,
}
,
status:
{
Description: The status of the token example enabled or disabled. ,
Enum:
{
enabled: No description available. ,
disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the token. ,
Required: False ,
}
{
creationDate:
{
Description: The creation date of scope map. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
scopeMapId:
{
Description: The resource ID of the scope map to which the token will be associated with. ,
Required: False ,
}
string ,
credentials:
{
Description: The credentials that can be used for authenticating the token. ,
Required: False ,
}
{
activeDirectoryObject:
{
Description: The Active Directory Object that will be used for authenticating the token of a container registry. ,
Required: False ,
}
{
objectId:
{
Description: The user/group/application object ID for Active Directory Object that will be used for authenticating the token of a container registry. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of user/group/application object Active Directory Object that will be used for authenticating the token of a container registry. ,
Required: False ,
}
string ,
}
,
certificates:
{
Required: False ,
}
[
{
name:
{
Enum:
{
certificate1: No description available. ,
certificate2: No description available. ,
}
,
Required: False ,
}
enum ,
expiry:
{
Description: The expiry datetime of the certificate. ,
Format: date-time ,
Required: False ,
}
string ,
thumbprint:
{
Description: The thumbprint of the certificate. ,
Required: False ,
}
string ,
encodedPemCertificate:
{
Description: Base 64 encoded string of the public certificate1 in PEM format that will be used for authenticating the token. ,
Required: False ,
}
string ,
}
,
]
,
passwords:
{
Required: False ,
}
[
{
creationTime:
{
Description: The creation datetime of the password. ,
Format: date-time ,
Required: False ,
}
string ,
expiry:
{
Description: The expiry datetime of the password. ,
Format: date-time ,
Required: False ,
}
string ,
name:
{
Description: The password name "password1" or "password2" ,
Enum:
{
password1: No description available. ,
password2: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The password value. ,
Required: False ,
}
string ,
}
,
]
,
}
,
status:
{
Description: The status of the token example enabled or disabled. ,
Enum:
{
enabled: No description available. ,
disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The properties of the token. ,
Required: False ,
}
{
creationDate:
{
Description: The creation date of scope map. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
scopeMapId:
{
Description: The resource ID of the scope map to which the token will be associated with. ,
Required: False ,
}
string ,
credentials:
{
Description: The credentials that can be used for authenticating the token. ,
Required: False ,
}
{
activeDirectoryObject:
{
Description: The Active Directory Object that will be used for authenticating the token of a container registry. ,
Required: False ,
}
{
objectId:
{
Description: The user/group/application object ID for Active Directory Object that will be used for authenticating the token of a container registry. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of user/group/application object Active Directory Object that will be used for authenticating the token of a container registry. ,
Required: False ,
}
string ,
}
,
certificates:
{
Required: False ,
}
[
{
name:
{
Enum:
{
certificate1: No description available. ,
certificate2: No description available. ,
}
,
Required: False ,
}
enum ,
expiry:
{
Description: The expiry datetime of the certificate. ,
Format: date-time ,
Required: False ,
}
string ,
thumbprint:
{
Description: The thumbprint of the certificate. ,
Required: False ,
}
string ,
encodedPemCertificate:
{
Description: Base 64 encoded string of the public certificate1 in PEM format that will be used for authenticating the token. ,
Required: False ,
}
string ,
}
,
]
,
passwords:
{
Required: False ,
}
[
{
creationTime:
{
Description: The creation datetime of the password. ,
Format: date-time ,
Required: False ,
}
string ,
expiry:
{
Description: The expiry datetime of the password. ,
Format: date-time ,
Required: False ,
}
string ,
name:
{
Description: The password name "password1" or "password2" ,
Enum:
{
password1: No description available. ,
password2: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The password value. ,
Required: False ,
}
string ,
}
,
]
,
}
,
status:
{
Description: The status of the token example enabled or disabled. ,
Enum:
{
enabled: No description available. ,
disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
Tokens_Delete (new)
Description :  Deletes a token from a container registry.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/tokens/{tokenName}
{
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group to which the container registry belongs. ,
Required: True ,
}
string ,
registryName:
{
Description: The name of the container registry. ,
Required: True ,
}
string ,
tokenName:
{
Description: The name of the token. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}
Tokens_Update (new)
Description :  Updates a token with the specified parameters.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/tokens/{tokenName}
{
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group to which the container registry belongs. ,
Required: True ,
}
string ,
registryName:
{
Description: The name of the container registry. ,
Required: True ,
}
string ,
tokenName:
{
Description: The name of the token. ,
Required: True ,
}
string ,
tokenUpdateParameters:
{
Description: The parameters for updating a token. ,
Required: True ,
}
{
properties:
{
Description: The properties of the token update parameters. ,
Required: False ,
}
{
scopeMapId:
{
Description: The resource ID of the scope map to which the token will be associated with. ,
Required: False ,
}
string ,
status:
{
Description: The status of the token example enabled or disabled. ,
Enum:
{
enabled: No description available. ,
disabled: No description available. ,
}
,
Required: False ,
}
enum ,
credentials:
{
Description: The credentials that can be used for authenticating the token. ,
Required: False ,
}
{
activeDirectoryObject:
{
Description: The Active Directory Object that will be used for authenticating the token of a container registry. ,
Required: False ,
}
{
objectId:
{
Description: The user/group/application object ID for Active Directory Object that will be used for authenticating the token of a container registry. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of user/group/application object Active Directory Object that will be used for authenticating the token of a container registry. ,
Required: False ,
}
string ,
}
,
certificates:
{
Required: False ,
}
[
{
name:
{
Enum:
{
certificate1: No description available. ,
certificate2: No description available. ,
}
,
Required: False ,
}
enum ,
expiry:
{
Description: The expiry datetime of the certificate. ,
Format: date-time ,
Required: False ,
}
string ,
thumbprint:
{
Description: The thumbprint of the certificate. ,
Required: False ,
}
string ,
encodedPemCertificate:
{
Description: Base 64 encoded string of the public certificate1 in PEM format that will be used for authenticating the token. ,
Required: False ,
}
string ,
}
,
]
,
passwords:
{
Required: False ,
}
[
{
creationTime:
{
Description: The creation datetime of the password. ,
Format: date-time ,
Required: False ,
}
string ,
expiry:
{
Description: The expiry datetime of the password. ,
Format: date-time ,
Required: False ,
}
string ,
name:
{
Description: The password name "password1" or "password2" ,
Enum:
{
password1: No description available. ,
password2: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The password value. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the token. ,
Required: False ,
}
{
creationDate:
{
Description: The creation date of scope map. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
scopeMapId:
{
Description: The resource ID of the scope map to which the token will be associated with. ,
Required: False ,
}
string ,
credentials:
{
Description: The credentials that can be used for authenticating the token. ,
Required: False ,
}
{
activeDirectoryObject:
{
Description: The Active Directory Object that will be used for authenticating the token of a container registry. ,
Required: False ,
}
{
objectId:
{
Description: The user/group/application object ID for Active Directory Object that will be used for authenticating the token of a container registry. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of user/group/application object Active Directory Object that will be used for authenticating the token of a container registry. ,
Required: False ,
}
string ,
}
,
certificates:
{
Required: False ,
}
[
{
name:
{
Enum:
{
certificate1: No description available. ,
certificate2: No description available. ,
}
,
Required: False ,
}
enum ,
expiry:
{
Description: The expiry datetime of the certificate. ,
Format: date-time ,
Required: False ,
}
string ,
thumbprint:
{
Description: The thumbprint of the certificate. ,
Required: False ,
}
string ,
encodedPemCertificate:
{
Description: Base 64 encoded string of the public certificate1 in PEM format that will be used for authenticating the token. ,
Required: False ,
}
string ,
}
,
]
,
passwords:
{
Required: False ,
}
[
{
creationTime:
{
Description: The creation datetime of the password. ,
Format: date-time ,
Required: False ,
}
string ,
expiry:
{
Description: The expiry datetime of the password. ,
Format: date-time ,
Required: False ,
}
string ,
name:
{
Description: The password name "password1" or "password2" ,
Enum:
{
password1: No description available. ,
password2: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The password value. ,
Required: False ,
}
string ,
}
,
]
,
}
,
status:
{
Description: The status of the token example enabled or disabled. ,
Enum:
{
enabled: No description available. ,
disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The properties of the token. ,
Required: False ,
}
{
creationDate:
{
Description: The creation date of scope map. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
scopeMapId:
{
Description: The resource ID of the scope map to which the token will be associated with. ,
Required: False ,
}
string ,
credentials:
{
Description: The credentials that can be used for authenticating the token. ,
Required: False ,
}
{
activeDirectoryObject:
{
Description: The Active Directory Object that will be used for authenticating the token of a container registry. ,
Required: False ,
}
{
objectId:
{
Description: The user/group/application object ID for Active Directory Object that will be used for authenticating the token of a container registry. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of user/group/application object Active Directory Object that will be used for authenticating the token of a container registry. ,
Required: False ,
}
string ,
}
,
certificates:
{
Required: False ,
}
[
{
name:
{
Enum:
{
certificate1: No description available. ,
certificate2: No description available. ,
}
,
Required: False ,
}
enum ,
expiry:
{
Description: The expiry datetime of the certificate. ,
Format: date-time ,
Required: False ,
}
string ,
thumbprint:
{
Description: The thumbprint of the certificate. ,
Required: False ,
}
string ,
encodedPemCertificate:
{
Description: Base 64 encoded string of the public certificate1 in PEM format that will be used for authenticating the token. ,
Required: False ,
}
string ,
}
,
]
,
passwords:
{
Required: False ,
}
[
{
creationTime:
{
Description: The creation datetime of the password. ,
Format: date-time ,
Required: False ,
}
string ,
expiry:
{
Description: The expiry datetime of the password. ,
Format: date-time ,
Required: False ,
}
string ,
name:
{
Description: The password name "password1" or "password2" ,
Enum:
{
password1: No description available. ,
password2: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The password value. ,
Required: False ,
}
string ,
}
,
]
,
}
,
status:
{
Description: The status of the token example enabled or disabled. ,
Enum:
{
enabled: No description available. ,
disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
Tokens_List (new)
Description :  Lists all the tokens for the specified container registry.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/tokens
{
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group to which the container registry belongs. ,
Required: True ,
}
string ,
registryName:
{
Description: The name of the container registry. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of tokens. Since this list may be incomplete, the nextLink field should be used to request the next list of tokens. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the token. ,
Required: False ,
}
{
creationDate:
{
Description: The creation date of scope map. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
scopeMapId:
{
Description: The resource ID of the scope map to which the token will be associated with. ,
Required: False ,
}
string ,
credentials:
{
Description: The credentials that can be used for authenticating the token. ,
Required: False ,
}
{
activeDirectoryObject:
{
Description: The Active Directory Object that will be used for authenticating the token of a container registry. ,
Required: False ,
}
{
objectId:
{
Description: The user/group/application object ID for Active Directory Object that will be used for authenticating the token of a container registry. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of user/group/application object Active Directory Object that will be used for authenticating the token of a container registry. ,
Required: False ,
}
string ,
}
,
certificates:
{
Required: False ,
}
[
{
name:
{
Enum:
{
certificate1: No description available. ,
certificate2: No description available. ,
}
,
Required: False ,
}
enum ,
expiry:
{
Description: The expiry datetime of the certificate. ,
Format: date-time ,
Required: False ,
}
string ,
thumbprint:
{
Description: The thumbprint of the certificate. ,
Required: False ,
}
string ,
encodedPemCertificate:
{
Description: Base 64 encoded string of the public certificate1 in PEM format that will be used for authenticating the token. ,
Required: False ,
}
string ,
}
,
]
,
passwords:
{
Required: False ,
}
[
{
creationTime:
{
Description: The creation datetime of the password. ,
Format: date-time ,
Required: False ,
}
string ,
expiry:
{
Description: The expiry datetime of the password. ,
Format: date-time ,
Required: False ,
}
string ,
name:
{
Description: The password name "password1" or "password2" ,
Enum:
{
password1: No description available. ,
password2: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The password value. ,
Required: False ,
}
string ,
}
,
]
,
}
,
status:
{
Description: The status of the token example enabled or disabled. ,
Enum:
{
enabled: No description available. ,
disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The URI that can be used to request the next list of tokens. ,
Required: False ,
}
string ,
}
Registries_GenerateCredentials (new)
Description :  Generate keys for a token of a specified container registry.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/generateCredentials
{
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group to which the container registry belongs. ,
Required: True ,
}
string ,
registryName:
{
Description: The name of the container registry. ,
Required: True ,
}
string ,
generateCredentialsParameters:
{
Description: The parameters for generating credentials. ,
Required: True ,
}
{
tokenId:
{
Description: The resource ID of the token for which credentials have to be generated. ,
Required: False ,
}
string ,
expiry:
{
Description: The expiry date of the generated credentials after which the credentials become invalid. ,
Format: date-time ,
Required: False ,
}
string ,
name:
{
Description: Specifies name of the password which should be regenerated if any -- password1 or password2. ,
Enum:
{
password1: No description available. ,
password2: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (200)

{
username:
{
Description: The username for a container registry. ,
Required: False ,
}
string ,
passwords:
{
Description: The list of passwords for a container registry. ,
Required: False ,
}
[
{
creationTime:
{
Description: The creation datetime of the password. ,
Format: date-time ,
Required: False ,
}
string ,
expiry:
{
Description: The expiry datetime of the password. ,
Format: date-time ,
Required: False ,
}
string ,
name:
{
Description: The password name "password1" or "password2" ,
Enum:
{
password1: No description available. ,
password2: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The password value. ,
Required: False ,
}
string ,
}
,
]
,
}

⚐ Response (202)

{}
ScopeMaps_Get (removed)
Description :  Gets the properties of the specified scope map.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/scopeMaps/{scopeMapName}
{
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group to which the container registry belongs. ,
Required: True ,
}
string ,
registryName:
{
Description: The name of the container registry. ,
Required: True ,
}
string ,
scopeMapName:
{
Description: The name of the scope map. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the scope map. ,
Required: False ,
}
{
description:
{
Description: The user friendly description of the scope map. ,
Required: False ,
}
string ,
type:
{
Description: The type of the scope map. E.g. BuildIn scope map. ,
Required: False ,
}
string ,
creationDate:
{
Description: The creation date of scope map. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
actions:
{
Description: The list of scoped permissions for registry artifacts. E.g. repositories/repository-name/content/read, repositories/repository-name/metadata/write ,
Required: True ,
}
[
string ,
]
,
}
,
}
ScopeMaps_Create (removed)
Description :  Creates a scope map for a container registry with the specified parameters.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/scopeMaps/{scopeMapName}
{
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group to which the container registry belongs. ,
Required: True ,
}
string ,
registryName:
{
Description: The name of the container registry. ,
Required: True ,
}
string ,
scopeMapName:
{
Description: The name of the scope map. ,
Required: True ,
}
string ,
scopeMapCreateParameters:
{
Description: The parameters for creating a scope map. ,
Required: True ,
}
{
properties:
{
Description: The properties of the scope map. ,
Required: False ,
}
{
description:
{
Description: The user friendly description of the scope map. ,
Required: False ,
}
string ,
type:
{
Description: The type of the scope map. E.g. BuildIn scope map. ,
Required: False ,
}
string ,
creationDate:
{
Description: The creation date of scope map. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
actions:
{
Description: The list of scoped permissions for registry artifacts. E.g. repositories/repository-name/content/read, repositories/repository-name/metadata/write ,
Required: True ,
}
[
string ,
]
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the scope map. ,
Required: False ,
}
{
description:
{
Description: The user friendly description of the scope map. ,
Required: False ,
}
string ,
type:
{
Description: The type of the scope map. E.g. BuildIn scope map. ,
Required: False ,
}
string ,
creationDate:
{
Description: The creation date of scope map. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
actions:
{
Description: The list of scoped permissions for registry artifacts. E.g. repositories/repository-name/content/read, repositories/repository-name/metadata/write ,
Required: True ,
}
[
string ,
]
,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The properties of the scope map. ,
Required: False ,
}
{
description:
{
Description: The user friendly description of the scope map. ,
Required: False ,
}
string ,
type:
{
Description: The type of the scope map. E.g. BuildIn scope map. ,
Required: False ,
}
string ,
creationDate:
{
Description: The creation date of scope map. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
actions:
{
Description: The list of scoped permissions for registry artifacts. E.g. repositories/repository-name/content/read, repositories/repository-name/metadata/write ,
Required: True ,
}
[
string ,
]
,
}
,
}
ScopeMaps_Delete (removed)
Description :  Deletes a scope map from a container registry.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/scopeMaps/{scopeMapName}
{
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group to which the container registry belongs. ,
Required: True ,
}
string ,
registryName:
{
Description: The name of the container registry. ,
Required: True ,
}
string ,
scopeMapName:
{
Description: The name of the scope map. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}
ScopeMaps_Update (removed)
Description :  Updates a scope map with the specified parameters.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/scopeMaps/{scopeMapName}
{
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group to which the container registry belongs. ,
Required: True ,
}
string ,
registryName:
{
Description: The name of the container registry. ,
Required: True ,
}
string ,
scopeMapName:
{
Description: The name of the scope map. ,
Required: True ,
}
string ,
scopeMapUpdateParameters:
{
Description: The parameters for updating a scope map. ,
Required: True ,
}
{
properties:
{
Description: The update parameters for scope map properties. ,
Required: False ,
}
{
description:
{
Description: The user friendly description of the scope map. ,
Required: False ,
}
string ,
actions:
{
Description: The list of scope permissions for registry artifacts. E.g. repositories/repository-name/pull, repositories/repository-name/delete ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the scope map. ,
Required: False ,
}
{
description:
{
Description: The user friendly description of the scope map. ,
Required: False ,
}
string ,
type:
{
Description: The type of the scope map. E.g. BuildIn scope map. ,
Required: False ,
}
string ,
creationDate:
{
Description: The creation date of scope map. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
actions:
{
Description: The list of scoped permissions for registry artifacts. E.g. repositories/repository-name/content/read, repositories/repository-name/metadata/write ,
Required: True ,
}
[
string ,
]
,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The properties of the scope map. ,
Required: False ,
}
{
description:
{
Description: The user friendly description of the scope map. ,
Required: False ,
}
string ,
type:
{
Description: The type of the scope map. E.g. BuildIn scope map. ,
Required: False ,
}
string ,
creationDate:
{
Description: The creation date of scope map. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
actions:
{
Description: The list of scoped permissions for registry artifacts. E.g. repositories/repository-name/content/read, repositories/repository-name/metadata/write ,
Required: True ,
}
[
string ,
]
,
}
,
}
ScopeMaps_List (removed)
Description :  Lists all the scope maps for the specified container registry.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/scopeMaps
{
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group to which the container registry belongs. ,
Required: True ,
}
string ,
registryName:
{
Description: The name of the container registry. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
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. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the scope map. ,
Required: False ,
}
{
description:
{
Description: The user friendly description of the scope map. ,
Required: False ,
}
string ,
type:
{
Description: The type of the scope map. E.g. BuildIn scope map. ,
Required: False ,
}
string ,
creationDate:
{
Description: The creation date of scope map. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
actions:
{
Description: The list of scoped permissions for registry artifacts. E.g. repositories/repository-name/content/read, repositories/repository-name/metadata/write ,
Required: True ,
}
[
string ,
]
,
}
,
}
,
]
,
nextLink:
{
Description: The URI that can be used to request the next list of scope maps. ,
Required: False ,
}
string ,
}
Tokens_Get (removed)
Description :  Gets the properties of the specified token.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/tokens/{tokenName}
{
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group to which the container registry belongs. ,
Required: True ,
}
string ,
registryName:
{
Description: The name of the container registry. ,
Required: True ,
}
string ,
tokenName:
{
Description: The name of the token. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the token. ,
Required: False ,
}
{
creationDate:
{
Description: The creation date of scope map. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
scopeMapId:
{
Description: The resource ID of the scope map to which the token will be associated with. ,
Required: False ,
}
string ,
credentials:
{
Description: The credentials that can be used for authenticating the token. ,
Required: False ,
}
{
activeDirectoryObject:
{
Description: The Active Directory Object that will be used for authenticating the token of a container registry. ,
Required: False ,
}
{
objectId:
{
Description: The user/group/application object ID for Active Directory Object that will be used for authenticating the token of a container registry. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of user/group/application object Active Directory Object that will be used for authenticating the token of a container registry. ,
Required: False ,
}
string ,
}
,
certificates:
{
Required: False ,
}
[
{
name:
{
Enum:
{
certificate1: No description available. ,
certificate2: No description available. ,
}
,
Required: False ,
}
enum ,
expiry:
{
Description: The expiry datetime of the certificate. ,
Format: date-time ,
Required: False ,
}
string ,
thumbprint:
{
Description: The thumbprint of the certificate. ,
Required: False ,
}
string ,
encodedPemCertificate:
{
Description: Base 64 encoded string of the public certificate1 in PEM format that will be used for authenticating the token. ,
Required: False ,
}
string ,
}
,
]
,
passwords:
{
Required: False ,
}
[
{
creationTime:
{
Description: The creation datetime of the password. ,
Format: date-time ,
Required: False ,
}
string ,
expiry:
{
Description: The expiry datetime of the password. ,
Format: date-time ,
Required: False ,
}
string ,
name:
{
Description: The password name "password1" or "password2" ,
Enum:
{
password1: No description available. ,
password2: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The password value. ,
Required: False ,
}
string ,
}
,
]
,
}
,
status:
{
Description: The status of the token example enabled or disabled. ,
Enum:
{
enabled: No description available. ,
disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
Tokens_Create (removed)
Description :  Creates a token for a container registry with the specified parameters.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/tokens/{tokenName}
{
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group to which the container registry belongs. ,
Required: True ,
}
string ,
registryName:
{
Description: The name of the container registry. ,
Required: True ,
}
string ,
tokenName:
{
Description: The name of the token. ,
Required: True ,
}
string ,
tokenCreateParameters:
{
Description: The parameters for creating a token. ,
Required: True ,
}
{
properties:
{
Description: The properties of the token. ,
Required: False ,
}
{
creationDate:
{
Description: The creation date of scope map. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
scopeMapId:
{
Description: The resource ID of the scope map to which the token will be associated with. ,
Required: False ,
}
string ,
credentials:
{
Description: The credentials that can be used for authenticating the token. ,
Required: False ,
}
{
activeDirectoryObject:
{
Description: The Active Directory Object that will be used for authenticating the token of a container registry. ,
Required: False ,
}
{
objectId:
{
Description: The user/group/application object ID for Active Directory Object that will be used for authenticating the token of a container registry. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of user/group/application object Active Directory Object that will be used for authenticating the token of a container registry. ,
Required: False ,
}
string ,
}
,
certificates:
{
Required: False ,
}
[
{
name:
{
Enum:
{
certificate1: No description available. ,
certificate2: No description available. ,
}
,
Required: False ,
}
enum ,
expiry:
{
Description: The expiry datetime of the certificate. ,
Format: date-time ,
Required: False ,
}
string ,
thumbprint:
{
Description: The thumbprint of the certificate. ,
Required: False ,
}
string ,
encodedPemCertificate:
{
Description: Base 64 encoded string of the public certificate1 in PEM format that will be used for authenticating the token. ,
Required: False ,
}
string ,
}
,
]
,
passwords:
{
Required: False ,
}
[
{
creationTime:
{
Description: The creation datetime of the password. ,
Format: date-time ,
Required: False ,
}
string ,
expiry:
{
Description: The expiry datetime of the password. ,
Format: date-time ,
Required: False ,
}
string ,
name:
{
Description: The password name "password1" or "password2" ,
Enum:
{
password1: No description available. ,
password2: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The password value. ,
Required: False ,
}
string ,
}
,
]
,
}
,
status:
{
Description: The status of the token example enabled or disabled. ,
Enum:
{
enabled: No description available. ,
disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the token. ,
Required: False ,
}
{
creationDate:
{
Description: The creation date of scope map. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
scopeMapId:
{
Description: The resource ID of the scope map to which the token will be associated with. ,
Required: False ,
}
string ,
credentials:
{
Description: The credentials that can be used for authenticating the token. ,
Required: False ,
}
{
activeDirectoryObject:
{
Description: The Active Directory Object that will be used for authenticating the token of a container registry. ,
Required: False ,
}
{
objectId:
{
Description: The user/group/application object ID for Active Directory Object that will be used for authenticating the token of a container registry. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of user/group/application object Active Directory Object that will be used for authenticating the token of a container registry. ,
Required: False ,
}
string ,
}
,
certificates:
{
Required: False ,
}
[
{
name:
{
Enum:
{
certificate1: No description available. ,
certificate2: No description available. ,
}
,
Required: False ,
}
enum ,
expiry:
{
Description: The expiry datetime of the certificate. ,
Format: date-time ,
Required: False ,
}
string ,
thumbprint:
{
Description: The thumbprint of the certificate. ,
Required: False ,
}
string ,
encodedPemCertificate:
{
Description: Base 64 encoded string of the public certificate1 in PEM format that will be used for authenticating the token. ,
Required: False ,
}
string ,
}
,
]
,
passwords:
{
Required: False ,
}
[
{
creationTime:
{
Description: The creation datetime of the password. ,
Format: date-time ,
Required: False ,
}
string ,
expiry:
{
Description: The expiry datetime of the password. ,
Format: date-time ,
Required: False ,
}
string ,
name:
{
Description: The password name "password1" or "password2" ,
Enum:
{
password1: No description available. ,
password2: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The password value. ,
Required: False ,
}
string ,
}
,
]
,
}
,
status:
{
Description: The status of the token example enabled or disabled. ,
Enum:
{
enabled: No description available. ,
disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The properties of the token. ,
Required: False ,
}
{
creationDate:
{
Description: The creation date of scope map. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
scopeMapId:
{
Description: The resource ID of the scope map to which the token will be associated with. ,
Required: False ,
}
string ,
credentials:
{
Description: The credentials that can be used for authenticating the token. ,
Required: False ,
}
{
activeDirectoryObject:
{
Description: The Active Directory Object that will be used for authenticating the token of a container registry. ,
Required: False ,
}
{
objectId:
{
Description: The user/group/application object ID for Active Directory Object that will be used for authenticating the token of a container registry. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of user/group/application object Active Directory Object that will be used for authenticating the token of a container registry. ,
Required: False ,
}
string ,
}
,
certificates:
{
Required: False ,
}
[
{
name:
{
Enum:
{
certificate1: No description available. ,
certificate2: No description available. ,
}
,
Required: False ,
}
enum ,
expiry:
{
Description: The expiry datetime of the certificate. ,
Format: date-time ,
Required: False ,
}
string ,
thumbprint:
{
Description: The thumbprint of the certificate. ,
Required: False ,
}
string ,
encodedPemCertificate:
{
Description: Base 64 encoded string of the public certificate1 in PEM format that will be used for authenticating the token. ,
Required: False ,
}
string ,
}
,
]
,
passwords:
{
Required: False ,
}
[
{
creationTime:
{
Description: The creation datetime of the password. ,
Format: date-time ,
Required: False ,
}
string ,
expiry:
{
Description: The expiry datetime of the password. ,
Format: date-time ,
Required: False ,
}
string ,
name:
{
Description: The password name "password1" or "password2" ,
Enum:
{
password1: No description available. ,
password2: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The password value. ,
Required: False ,
}
string ,
}
,
]
,
}
,
status:
{
Description: The status of the token example enabled or disabled. ,
Enum:
{
enabled: No description available. ,
disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
Tokens_Delete (removed)
Description :  Deletes a token from a container registry.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/tokens/{tokenName}
{
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group to which the container registry belongs. ,
Required: True ,
}
string ,
registryName:
{
Description: The name of the container registry. ,
Required: True ,
}
string ,
tokenName:
{
Description: The name of the token. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}
Tokens_Update (removed)
Description :  Updates a token with the specified parameters.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/tokens/{tokenName}
{
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group to which the container registry belongs. ,
Required: True ,
}
string ,
registryName:
{
Description: The name of the container registry. ,
Required: True ,
}
string ,
tokenName:
{
Description: The name of the token. ,
Required: True ,
}
string ,
tokenUpdateParameters:
{
Description: The parameters for updating a token. ,
Required: True ,
}
{
properties:
{
Description: The properties of the token update parameters. ,
Required: False ,
}
{
scopeMapId:
{
Description: The resource ID of the scope map to which the token will be associated with. ,
Required: False ,
}
string ,
status:
{
Description: The status of the token example enabled or disabled. ,
Enum:
{
enabled: No description available. ,
disabled: No description available. ,
}
,
Required: False ,
}
enum ,
credentials:
{
Description: The credentials that can be used for authenticating the token. ,
Required: False ,
}
{
activeDirectoryObject:
{
Description: The Active Directory Object that will be used for authenticating the token of a container registry. ,
Required: False ,
}
{
objectId:
{
Description: The user/group/application object ID for Active Directory Object that will be used for authenticating the token of a container registry. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of user/group/application object Active Directory Object that will be used for authenticating the token of a container registry. ,
Required: False ,
}
string ,
}
,
certificates:
{
Required: False ,
}
[
{
name:
{
Enum:
{
certificate1: No description available. ,
certificate2: No description available. ,
}
,
Required: False ,
}
enum ,
expiry:
{
Description: The expiry datetime of the certificate. ,
Format: date-time ,
Required: False ,
}
string ,
thumbprint:
{
Description: The thumbprint of the certificate. ,
Required: False ,
}
string ,
encodedPemCertificate:
{
Description: Base 64 encoded string of the public certificate1 in PEM format that will be used for authenticating the token. ,
Required: False ,
}
string ,
}
,
]
,
passwords:
{
Required: False ,
}
[
{
creationTime:
{
Description: The creation datetime of the password. ,
Format: date-time ,
Required: False ,
}
string ,
expiry:
{
Description: The expiry datetime of the password. ,
Format: date-time ,
Required: False ,
}
string ,
name:
{
Description: The password name "password1" or "password2" ,
Enum:
{
password1: No description available. ,
password2: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The password value. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the token. ,
Required: False ,
}
{
creationDate:
{
Description: The creation date of scope map. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
scopeMapId:
{
Description: The resource ID of the scope map to which the token will be associated with. ,
Required: False ,
}
string ,
credentials:
{
Description: The credentials that can be used for authenticating the token. ,
Required: False ,
}
{
activeDirectoryObject:
{
Description: The Active Directory Object that will be used for authenticating the token of a container registry. ,
Required: False ,
}
{
objectId:
{
Description: The user/group/application object ID for Active Directory Object that will be used for authenticating the token of a container registry. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of user/group/application object Active Directory Object that will be used for authenticating the token of a container registry. ,
Required: False ,
}
string ,
}
,
certificates:
{
Required: False ,
}
[
{
name:
{
Enum:
{
certificate1: No description available. ,
certificate2: No description available. ,
}
,
Required: False ,
}
enum ,
expiry:
{
Description: The expiry datetime of the certificate. ,
Format: date-time ,
Required: False ,
}
string ,
thumbprint:
{
Description: The thumbprint of the certificate. ,
Required: False ,
}
string ,
encodedPemCertificate:
{
Description: Base 64 encoded string of the public certificate1 in PEM format that will be used for authenticating the token. ,
Required: False ,
}
string ,
}
,
]
,
passwords:
{
Required: False ,
}
[
{
creationTime:
{
Description: The creation datetime of the password. ,
Format: date-time ,
Required: False ,
}
string ,
expiry:
{
Description: The expiry datetime of the password. ,
Format: date-time ,
Required: False ,
}
string ,
name:
{
Description: The password name "password1" or "password2" ,
Enum:
{
password1: No description available. ,
password2: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The password value. ,
Required: False ,
}
string ,
}
,
]
,
}
,
status:
{
Description: The status of the token example enabled or disabled. ,
Enum:
{
enabled: No description available. ,
disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The properties of the token. ,
Required: False ,
}
{
creationDate:
{
Description: The creation date of scope map. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
scopeMapId:
{
Description: The resource ID of the scope map to which the token will be associated with. ,
Required: False ,
}
string ,
credentials:
{
Description: The credentials that can be used for authenticating the token. ,
Required: False ,
}
{
activeDirectoryObject:
{
Description: The Active Directory Object that will be used for authenticating the token of a container registry. ,
Required: False ,
}
{
objectId:
{
Description: The user/group/application object ID for Active Directory Object that will be used for authenticating the token of a container registry. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of user/group/application object Active Directory Object that will be used for authenticating the token of a container registry. ,
Required: False ,
}
string ,
}
,
certificates:
{
Required: False ,
}
[
{
name:
{
Enum:
{
certificate1: No description available. ,
certificate2: No description available. ,
}
,
Required: False ,
}
enum ,
expiry:
{
Description: The expiry datetime of the certificate. ,
Format: date-time ,
Required: False ,
}
string ,
thumbprint:
{
Description: The thumbprint of the certificate. ,
Required: False ,
}
string ,
encodedPemCertificate:
{
Description: Base 64 encoded string of the public certificate1 in PEM format that will be used for authenticating the token. ,
Required: False ,
}
string ,
}
,
]
,
passwords:
{
Required: False ,
}
[
{
creationTime:
{
Description: The creation datetime of the password. ,
Format: date-time ,
Required: False ,
}
string ,
expiry:
{
Description: The expiry datetime of the password. ,
Format: date-time ,
Required: False ,
}
string ,
name:
{
Description: The password name "password1" or "password2" ,
Enum:
{
password1: No description available. ,
password2: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The password value. ,
Required: False ,
}
string ,
}
,
]
,
}
,
status:
{
Description: The status of the token example enabled or disabled. ,
Enum:
{
enabled: No description available. ,
disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
Tokens_List (removed)
Description :  Lists all the tokens for the specified container registry.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/tokens
{
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group to which the container registry belongs. ,
Required: True ,
}
string ,
registryName:
{
Description: The name of the container registry. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of tokens. Since this list may be incomplete, the nextLink field should be used to request the next list of tokens. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the token. ,
Required: False ,
}
{
creationDate:
{
Description: The creation date of scope map. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
scopeMapId:
{
Description: The resource ID of the scope map to which the token will be associated with. ,
Required: False ,
}
string ,
credentials:
{
Description: The credentials that can be used for authenticating the token. ,
Required: False ,
}
{
activeDirectoryObject:
{
Description: The Active Directory Object that will be used for authenticating the token of a container registry. ,
Required: False ,
}
{
objectId:
{
Description: The user/group/application object ID for Active Directory Object that will be used for authenticating the token of a container registry. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of user/group/application object Active Directory Object that will be used for authenticating the token of a container registry. ,
Required: False ,
}
string ,
}
,
certificates:
{
Required: False ,
}
[
{
name:
{
Enum:
{
certificate1: No description available. ,
certificate2: No description available. ,
}
,
Required: False ,
}
enum ,
expiry:
{
Description: The expiry datetime of the certificate. ,
Format: date-time ,
Required: False ,
}
string ,
thumbprint:
{
Description: The thumbprint of the certificate. ,
Required: False ,
}
string ,
encodedPemCertificate:
{
Description: Base 64 encoded string of the public certificate1 in PEM format that will be used for authenticating the token. ,
Required: False ,
}
string ,
}
,
]
,
passwords:
{
Required: False ,
}
[
{
creationTime:
{
Description: The creation datetime of the password. ,
Format: date-time ,
Required: False ,
}
string ,
expiry:
{
Description: The expiry datetime of the password. ,
Format: date-time ,
Required: False ,
}
string ,
name:
{
Description: The password name "password1" or "password2" ,
Enum:
{
password1: No description available. ,
password2: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The password value. ,
Required: False ,
}
string ,
}
,
]
,
}
,
status:
{
Description: The status of the token example enabled or disabled. ,
Enum:
{
enabled: No description available. ,
disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The URI that can be used to request the next list of tokens. ,
Required: False ,
}
string ,
}
Registries_GenerateCredentials (removed)
Description :  Generate keys for a token of a specified container registry.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/generateCredentials
{
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group to which the container registry belongs. ,
Required: True ,
}
string ,
registryName:
{
Description: The name of the container registry. ,
Required: True ,
}
string ,
generateCredentialsParameters:
{
Description: The parameters for generating credentials. ,
Required: True ,
}
{
tokenId:
{
Description: The resource ID of the token for which credentials have to be generated. ,
Required: False ,
}
string ,
expiry:
{
Description: The expiry date of the generated credentials after which the credentials become invalid. ,
Format: date-time ,
Required: False ,
}
string ,
name:
{
Description: Specifies name of the password which should be regenerated if any -- password1 or password2. ,
Enum:
{
password1: No description available. ,
password2: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (200)

{
username:
{
Description: The username for a container registry. ,
Required: False ,
}
string ,
passwords:
{
Description: The list of passwords for a container registry. ,
Required: False ,
}
[
{
creationTime:
{
Description: The creation datetime of the password. ,
Format: date-time ,
Required: False ,
}
string ,
expiry:
{
Description: The expiry datetime of the password. ,
Format: date-time ,
Required: False ,
}
string ,
name:
{
Description: The password name "password1" or "password2" ,
Enum:
{
password1: No description available. ,
password2: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The password value. ,
Required: False ,
}
string ,
}
,
]
,
}

⚐ Response (202)

{}