Skip to content

Microsof.app 2022 01 01 preview/add custom domains #17385

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
akning-ms merged 36 commits into from
Feb 4, 2022
Merged

Microsof.app 2022 01 01 preview/add custom domains #17385

Show file tree
Hide file tree
Changes from 16 commits
Commits
Show all changes
36 commits
Select commit Hold shift + click to select a range
98de6eb
add support for Custom domains and certificates
vinisoto Jan 18, 2022
8f6cb60
add Certificates
vinisoto Jan 18, 2022
925c9c6
Ccertificate as child resource of Managed Env.
vinisoto Jan 18, 2022
6e3b5a4
Support default custom domain
vinisoto Jan 18, 2022
b716fd1
PUT/DELETE certificate are not long-running
vinisoto Jan 19, 2022
d47481b
Add Custom Domain Verification Id
vinisoto Jan 19, 2022
436f0b7
domains for all revisions and adding examples
vinisoto Jan 24, 2022
b00c1f0
missing examples
vinisoto Jan 24, 2022
e4b0d0f
one more missing example
vinisoto Jan 24, 2022
86c094e
Examples+missing paths
vinisoto Jan 26, 2022
3fce21c
Adding missing envelope properties
vinisoto Jan 26, 2022
7609023
Addressing PR comments
vinisoto Jan 27, 2022
b37c3ac
Removing AKV and Free cert related properties
vinisoto Jan 27, 2022
b9f3846
Prettier and semantic validation fixes
vinisoto Jan 28, 2022
8c1cd8b
Fixing semantic validations and examples
vinisoto Jan 28, 2022
34300f3
More fixes
vinisoto Jan 28, 2022
5d9fe2c
Addressing more PR comments
vinisoto Jan 29, 2022
b1f5004
Updating examples
vinisoto Jan 29, 2022
8da8fa5
fixing type
vinisoto Jan 29, 2022
0fbec14
fixing types
vinisoto Jan 29, 2022
4ccd72d
Extra properties and responses
vinisoto Jan 29, 2022
a98ac1a
misplaced response
vinisoto Jan 29, 2022
755f670
whitespace
vinisoto Jan 29, 2022
1a697d0
fix security section
vinisoto Jan 29, 2022
cbb2b95
fixing ManageEnvironment securityDefinitions
vinisoto Jan 31, 2022
64dab7a
add 204 delete response
vinisoto Jan 31, 2022
72b90e7
Removing virtual IP and IP Based option
vinisoto Jan 31, 2022
3ecab2b
change modelAsString
vinisoto Jan 31, 2022
e9b4877
Addressing ARM PR comments
vinisoto Feb 1, 2022
cdb52dd
Removing 404 response from example
vinisoto Feb 1, 2022
6792d83
renaming custom hostname analysis operation
vinisoto Feb 1, 2022
7eddc6e
mark certificate as tracked resource
ruslany Feb 1, 2022
37c0880
Merge pull request #1 from ruslany/customdomaintracked
vinisoto Feb 1, 2022
1ee5c24
fix sample
ruslany Feb 1, 2022
cdb9674
Merge pull request #2 from ruslany/fixsample
vinisoto Feb 1, 2022
2058c97
Use Certificate Id instead of Certificate name
Feb 3, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
187 changes: 187 additions & 0 deletions ...fication/app/resource-manager/Microsoft.App/preview/2022-01-01-preview/ContainerApps.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -309,6 +309,58 @@
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/containerApps/{containerAppName}/analyzeCustomHostName": {
Copy link
Member

@raosuhas raosuhas Jan 31, 2022 •
edited by ruslany
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

analyzeCustomHostName

any reason you are not choosing to name with list* something like .. listCustomHostProperties or something .

The reason I ask is since in ARM templates only list* operations are supported so you could do operations using the output values of this call. #Resolved

Copy link
Member

@raosuhas raosuhas Jan 31, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

See examples here : https://docs.microsoft.com/en-us/azure/azure-resource-manager/templates/template-functions-resource#list

Copy link
Contributor Author

@vinisoto vinisoto Feb 1, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@raosuhas For context: This API will check if a certain hostname (e.g., my-app.com) is valid for the app by performing a number of checks (e.g., hostname not being used by another app, customer owns the domain, etc.) and returning the results. I think analyze... describes better what the API actually does but I can see the merit on having it available for ARM templates. @ruslany what do you think?

"post": {
"tags": [
"ContainerApps"
],
"summary": "Analyzes a custom hostname for a Container App",
"operationId": "ContainerAppsRevisions_AnalyzeCustomHostName",
"parameters": [
{
"$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "containerAppName",
"in": "path",
"description": "Name of the Container App.",
"required": true,
"type": "string"
},
{
"name": "customHostname",
"in": "query",
"description": "Custom hostname.",
"type": "string"
},
{
"$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/CustomHostnameAnalysisResult"
}
},
"default": {
"description": "Common error response.",
"schema": {
"$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Patch Container App": {
"$ref": "./examples/ContainerAppsRevisions_AnalyzeCustomHostName.json"
}
}
}
}
},
"definitions": {
Expand Down Expand Up @@ -400,6 +452,11 @@
"type": "string",
"readOnly": true
},
"customDomainVerificationId": {
"description": "Id used to verify domain name ownership",
"type": "string",
"readOnly": true
},
"configuration": {
"$ref": "#/definitions/Configuration",
"description": "Non versioned Container App configuration properties."
Expand Down Expand Up @@ -489,6 +546,13 @@
"revisionName"
]
},
"customDomains": {
"description": "custom domain bindings for Container Apps' hostnames.",
"type": "array",
"items": {
"$ref": "#/definitions/CustomDomain"
}
},
"allowInsecure": {
"description": "Bool indicating if HTTP connections to is allowed. If set to false HTTP connections are automatically redirected to HTTPS connections",
"type": "boolean"
Expand Down Expand Up @@ -551,6 +615,129 @@
"type": "boolean"
}
}
},
"CustomDomain": {
"description": "Custom Domain of a Container App",
"type": "object",
"properties": {
"name": {
"description": "Hostname.",
"type": "string"
},
"bindingType": {
"description": "Custom Domain binding type.",
"enum": [
"Disabled",
"SniEnabled",
"IpBasedEnabled"
Copy link
Contributor

@ruslany ruslany Jan 27, 2022 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Are we going to support IpBased for containerapps? #Closed

Copy link
Contributor Author

@vinisoto vinisoto Jan 27, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We will once we support the "reservedIP" feature.

Copy link
Contributor

@ruslany ruslany Jan 28, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If this is not supported for GA then I think it is better not to have it in swagger.

Copy link
Contributor Author

@vinisoto vinisoto Jan 31, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

removed IPBasedEnabled

],
"type": "string",
"x-ms-enum": {
"name": "bindingType",
"modelAsString": false
}
},
"virtualIP": {
"description": "Virtual IP address assigned to the hostname if IP based binding is enabled.",
"type": "string"
},
"certificateName": {
"description": "Name of the Certificate to be bound to this hostname. Must exist in the Managed Environment.",
"type": "string"
}
}
},
"CustomHostnameAnalysisResult": {
"description": "Custom domain analysis.",
"type": "object",
"allOf": [
{
"$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/TrackedResource"
}
],
"properties": {
"properties": {
"description": "CustomHostnameAnalysisResult resource specific properties",
"type": "object",
"properties": {
"hostName": {
"description": "Host name that was analyzed",
"type": "string",
"readOnly": true
},
"isHostnameAlreadyVerified": {
"description": "<code>true</code> if hostname is already verified; otherwise, <code>false</code>.",
"type": "boolean",
"readOnly": true
},
"customDomainVerificationTest": {
"description": "DNS verification test result.",
"enum": [
"Passed",
"Failed",
"Skipped"
],
"type": "string",
"readOnly": true,
"x-ms-enum": {
"name": "DnsVerificationTestResult",
"modelAsString": false
}
},
"customDomainVerificationFailureInfo": {
"$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse",
"description": "Raw failure information if DNS verification fails.",
"readOnly": true
},
"hasConflictOnManagedEnvironment": {
"description": "<code>true</code> if there is a conflict on the Container App's managed environment; otherwise, <code>false</code>.",
"type": "boolean",
"readOnly": true
},
"conflictingContainerAppResourceId": {
"description": "Name of the conflicting Container App on the Managed Environment if it's within the same subscription.",
"type": "string",
"readOnly": true
},
"cNameRecords": {
"description": "CName records visible for this hostname.",
"type": "array",
"items": {
"type": "string"
}
},
"txtRecords": {
"description": "TXT records visible for this hostname.",
"type": "array",
"items": {
"type": "string"
}
},
"aRecords": {
"description": "A records visible for this hostname.",
"type": "array",
"items": {
"type": "string"
}
},
"alternateCNameRecords": {
"description": "Alternate CName records visible for this hostname.",
"type": "array",
"items": {
"type": "string"
}
},
"alternateTxtRecords": {
"description": "Alternate TXT records visible for this hostname.",
"type": "array",
"items": {
"type": "string"
}
}
},
"x-ms-client-flatten": true
}
}
}
},
"securityDefinitions": {
Expand Down
Loading