Deployments - List
Returns a collection of API deployments.
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiCenter/services/{serviceName}/workspaces/{workspaceName}/apis/{apiName}/deployments?api-version=2024-03-01
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiCenter/services/{serviceName}/workspaces/{workspaceName}/apis/{apiName}/deployments?api-version=2024-03-01&$filter={$filter}
URI Parameters
Name | In | Required | Type | Description |
---|---|---|---|---|
api
|
path | True |
string |
The name of the API. Regex pattern: |
resource
|
path | True |
string |
The name of the resource group. The name is case insensitive. |
service
|
path | True |
string |
The name of Azure API Center service. Regex pattern: |
subscription
|
path | True |
string uuid |
The ID of the target subscription. The value must be an UUID. |
workspace
|
path | True |
string |
The name of the workspace. Regex pattern: |
api-version
|
query | True |
string |
The API version to use for this operation. |
$filter
|
query |
string |
OData filter parameter. |
Responses
Name | Type | Description |
---|---|---|
200 OK |
Azure operation completed successfully. |
|
Other Status Codes |
An unexpected error response. |
Security
azure_auth
Azure Active Directory OAuth2 Flow.
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Name | Description |
---|---|
user_impersonation | impersonate your user account |
Examples
Deployments_ListByApi
Sample request
GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-resources/providers/Microsoft.ApiCenter/services/contoso/workspaces/default/apis/echo-api/deployments?api-version=2024-03-01
Sample response
{
"value": [
{
"type": "Microsoft.ApiCenter/services/apis/deployments",
"id": "/subscriptions/a200340d-6b82-494d-9dbf-687ba6e33f9e/resourceGroups/contoso-resources/providers/Microsoft.ApiCenter/services/contoso/workspaces/default/deployments/production",
"name": "public",
"systemData": {
"createdAt": "2023-07-03T18:27:09.128871Z",
"lastModifiedAt": "2023-07-03T18:27:09.1288716Z"
},
"properties": {
"title": "Development",
"description": "Public cloud production deployment.",
"environmentId": "/workspaces/default/environments/production",
"definitionId": "/workspaces/default/apis/echo-api/versions/2023-01-01/definitions/openapi",
"state": "active",
"server": {
"runtimeUri": [
"https://api.contoso.com"
]
}
}
}
]
}
Definitions
Name | Description |
---|---|
created |
The type of identity that created the resource. |
Deployment |
API deployment entity. |
Deployment |
The response of a Deployment list operation. |
Deployment |
Server |
Deployment |
State of the Deployment |
Error |
The resource management error additional info. |
Error |
The error detail. |
Error |
Error response |
system |
Metadata pertaining to creation and last modification of the resource. |
createdByType
The type of identity that created the resource.
Name | Type | Description |
---|---|---|
Application |
string |
|
Key |
string |
|
ManagedIdentity |
string |
|
User |
string |
Deployment
API deployment entity.
Name | Type | Description |
---|---|---|
id |
string |
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" |
name |
string |
The name of the resource |
properties.customProperties |
object |
Custom Properties |
properties.definitionId |
string |
API center-scoped definition resource ID. |
properties.description |
string |
Description of the deployment. |
properties.environmentId |
string |
API center-scoped environment resource ID. |
properties.server |
The deployment server |
|
properties.state |
State of API deployment. |
|
properties.title |
string |
API deployment title |
systemData |
Azure Resource Manager metadata containing createdBy and modifiedBy information. |
|
type |
string |
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" |
DeploymentListResult
The response of a Deployment list operation.
Name | Type | Description |
---|---|---|
nextLink |
string |
The link to the next page of items |
value |
The Deployment items on this page |
DeploymentServer
Server
Name | Type | Description |
---|---|---|
runtimeUri |
string[] |
Base runtime URLs for this deployment. |
DeploymentState
State of the Deployment
Name | Type | Description |
---|---|---|
active |
string |
Active State |
inactive |
string |
Inactive State |
ErrorAdditionalInfo
The resource management error additional info.
Name | Type | Description |
---|---|---|
info |
object |
The additional info. |
type |
string |
The additional info type. |
ErrorDetail
The error detail.
Name | Type | Description |
---|---|---|
additionalInfo |
The error additional info. |
|
code |
string |
The error code. |
details |
The error details. |
|
message |
string |
The error message. |
target |
string |
The error target. |
ErrorResponse
Error response
Name | Type | Description |
---|---|---|
error |
The error object. |
systemData
Metadata pertaining to creation and last modification of the resource.
Name | Type | Description |
---|---|---|
createdAt |
string |
The timestamp of resource creation (UTC). |
createdBy |
string |
The identity that created the resource. |
createdByType |
The type of identity that created the resource. |
|
lastModifiedAt |
string |
The timestamp of resource last modification (UTC) |
lastModifiedBy |
string |
The identity that last modified the resource. |
lastModifiedByType |
The type of identity that last modified the resource. |