-
Notifications
You must be signed in to change notification settings - Fork 16k
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.
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
[API Center] azure-api-center-create #13985
Merged
Merged
Changes from 6 commits
Commits
Show all changes
9 commits
Select commit
Hold shift + click to select a range
bf874c1
[API Center] azure-api-center-create
dlepow 3eaae79
edits
dlepow 0cf877d
Merge branch 'master' of https://github.com/Azure/azure-quickstart-te…
dlepow b9ee022
update README
dlepow 7f7285b
replaced with bicep template, updated README
dlepow 927be1a
indent
dlepow 439cd0b
Merge branch 'master' of https://github.com/Azure/azure-quickstart-te…
dlepow 0a82966
review updates
dlepow 7fb90a6
removed property
dlepow File filter
Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
There are no files selected for viewing
42 changes: 42 additions & 0 deletions
42
quickstarts/microsoft.apicenter/azure-api-center-create/README.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,42 @@ | ||
--- | ||
description: This template creates an instance of Azure API Center and registers a sample API. | ||
page_type: sample | ||
products: | ||
- azure | ||
- azure-resource-manager | ||
- azure-api-center | ||
urlFragment: azure-api-center-create | ||
languages: | ||
- bicep | ||
- json | ||
--- | ||
# Create an Azure API Center instance using a template | ||
|
||
![Azure Public Test Date](https://azurequickstartsservice.blob.core.windows.net/badges/quickstarts/microsoft.apicenter/azure-api-center-create/PublicLastTestDate.svg) | ||
![Azure Public Test Result](https://azurequickstartsservice.blob.core.windows.net/badges/quickstarts/microsoft.apicenter/azure-api-center-create/PublicDeployment.svg) | ||
|
||
![Azure US Gov Last Test Date](https://azurequickstartsservice.blob.core.windows.net/badges/quickstarts/microsoft.apicenter/azure-api-center-create/FairfaxLastTestDate.svg) | ||
![Azure US Gov Last Test Result](https://azurequickstartsservice.blob.core.windows.net/badges/quickstarts/microsoft.apicenter/azure-api-center-create/FairfaxDeployment.svg) | ||
|
||
![Best Practice Check](https://azurequickstartsservice.blob.core.windows.net/badges/quickstarts/microsoft.apicenter/azure-api-center-create/BestPracticeResult.svg) | ||
![Cred Scan Check](https://azurequickstartsservice.blob.core.windows.net/badges/quickstarts/microsoft.apicenter/azure-api-center-create/CredScanResult.svg) | ||
|
||
![Bicep Version](https://azurequickstartsservice.blob.core.windows.net/badges/quickstarts/microsoft.apicenter/azure-api-center-create/BicepVersion.svg) | ||
|
||
[![Deploy To Azure](https://raw.githubusercontent.com/Azure/azure-quickstart-templates/master/1-CONTRIBUTION-GUIDE/images/deploytoazure.svg?sanitize=true)](https://portal.azure.com/#create/Microsoft.Template/uri/https%3A%2F%2Fraw.githubusercontent.com%2FAzure%2Fazure-quickstart-templates%2Fmaster%2Fquickstarts%2Fmicrosoft.apicenter%2Fazure-api-center-create%2Fazuredeploy.json) | ||
[![Deploy To Azure US Gov](https://raw.githubusercontent.com/Azure/azure-quickstart-templates/master/1-CONTRIBUTION-GUIDE/images/deploytoazuregov.svg?sanitize=true)](https://portal.azure.us/#create/Microsoft.Template/uri/https%3A%2F%2Fraw.githubusercontent.com%2FAzure%2Fazure-quickstart-templates%2Fmaster%2Fquickstarts%2Fmicrosoft.apicenter%2Fazure-api-center-create%2Fazuredeploy.json) | ||
[![Visualize](https://raw.githubusercontent.com/Azure/azure-quickstart-templates/master/1-CONTRIBUTION-GUIDE/images/visualizebutton.svg?sanitize=true)](http://armviz.io/#/?load=https%3A%2F%2Fraw.githubusercontent.com%2FAzure%2Fazure-quickstart-templates%2Fmaster%2Fquickstarts%2Fmicrosoft.apicenter%2Fazure-api-center-create%2Fazuredeploy.json) | ||
|
||
This template deploys an API center and registers a sample API in the API center. For supported regions, see [Azure API Center overview](https://learn.microsoft.com/azure/api-center/overview#available-regions). | ||
|
||
## Parameters | ||
|
||
| Name | Type | Required | Description | | ||
| :------------- | :----------: | :----------: | :------------- | | ||
| location | string | Yes | Specifies the location for the API center. | | ||
| apiCenterName | string | Yes | Specifies the name of the API center. | | ||
| apiName | string | No | Specifies the name of an API to register in the API center. | | ||
| apiType | string | No | Specifies the type of API to register in the API center. Example *REST*. | | ||
|
||
|
||
`Tags: Microsoft.ApiCenter/service` |
12 changes: 12 additions & 0 deletions
12
quickstarts/microsoft.apicenter/azure-api-center-create/azuredeploy.parameters.json
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,12 @@ | ||
{ | ||
"$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#", | ||
"contentVersion": "1.0.0.0", | ||
"parameters": { | ||
"apiName": { | ||
"value": "first-api" | ||
}, | ||
"apiType": { | ||
"value": "rest" | ||
} | ||
} | ||
} |
43 changes: 43 additions & 0 deletions
43
quickstarts/microsoft.apicenter/azure-api-center-create/main.bicep
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,43 @@ | ||
@description('Specifies the location for resources.') | ||
param location string = 'eastus' | ||
@description('The name of the API center.') | ||
param apiCenterName string = 'apicenter${uniqueString(resourceGroup().id)}' | ||
@description('The name of an API to register in the API center.') | ||
param apiName string = 'first-api' | ||
@description('The type of the API to register in the API center.') | ||
@allowed([ | ||
'rest' | ||
'soap' | ||
'graphql' | ||
'grpc' | ||
'webhook' | ||
'websocket' | ||
]) | ||
param apiType string = 'rest' | ||
|
||
resource apiCenterService 'Microsoft.ApiCenter/services@2024-03-01' = { | ||
name: apiCenterName | ||
location: location | ||
properties: {} | ||
} | ||
|
||
resource apiCenterWorkspace 'Microsoft.ApiCenter/services/workspaces@2024-03-01' = { | ||
parent: apiCenterService | ||
name: 'default' | ||
properties: { | ||
title: 'Default workspace' | ||
description: 'Default workspace' | ||
} | ||
} | ||
|
||
resource apiCenterAPI 'Microsoft.ApiCenter/services/workspaces/apis@2024-03-01' = { | ||
parent: apiCenterWorkspace | ||
name: apiName | ||
properties: { | ||
title: apiName | ||
kind: apiType | ||
externalDocumentation: [] | ||
contacts: [] | ||
customProperties: {} | ||
} | ||
} |
10 changes: 10 additions & 0 deletions
10
quickstarts/microsoft.apicenter/azure-api-center-create/metadata.json
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
{ | ||
"$schema": "https://aka.ms/azure-quickstart-templates-metadata-schema#", | ||
"type": "QuickStart", | ||
"itemDisplayName": "Create an Azure API Center instance using a template", | ||
"description": "This template creates an API center and registers an API in the API center.", | ||
"summary": "Create an Azure API Center instance using a template", | ||
"githubUsername": "dlepow", | ||
"docOwner": "dlepow", | ||
"dateUpdated": "2024-04-17" | ||
} |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please change 'eastus' to resourceGroup().location.