Microsoft.ApiCenter services/workspaces/apiSources 2024-06-01-preview

Bicep resource definition

The services/workspaces/apiSources resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.ApiCenter/services/workspaces/apiSources resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.ApiCenter/services/workspaces/apiSources@2024-06-01-preview' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    azureApiManagementSource: {
      msiResourceId: 'string'
      resourceId: 'string'
    }
    importSpecification: 'string'
    targetEnvironmentId: 'string'
    targetLifecycleStage: 'string'
  }
}

Property Values

Microsoft.ApiCenter/services/workspaces/apiSources

Name Description Value
name The resource name string

Constraints:
Min length = 1
Max length = 90
Pattern = ^[a-zA-Z0-9-]{3,90}$ (required)
parent In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource.

For more information, see Child resource outside parent resource.		 Symbolic name for resource of type: services/workspaces
properties The resource-specific properties for this resource. ApiSourceProperties

ApiSourceProperties

Name Description Value
azureApiManagementSource API source configuration for Azure API Management. AzureApiManagementSource
importSpecification Indicates if the specification should be imported along with metadata. 'always'
'never'
'ondemand'
targetEnvironmentId The target environment resource ID. string
targetLifecycleStage The target lifecycle stage. 'deprecated'
'design'
'development'
'preview'
'production'
'retired'
'testing'

AzureApiManagementSource

Name Description Value
msiResourceId The resource ID of the managed identity that has access to the API Management instance. string
resourceId API Management service resource ID. string (required)

ARM template resource definition

The services/workspaces/apiSources resource type can be deployed with operations that target:

Usage Examples

Resource format

To create a Microsoft.ApiCenter/services/workspaces/apiSources resource, add the following JSON to your template.

{
  "type": "Microsoft.ApiCenter/services/workspaces/apiSources",
  "apiVersion": "2024-06-01-preview",
  "name": "string",
  "properties": {
    "azureApiManagementSource": {
      "msiResourceId": "string",
      "resourceId": "string"
    },
    "importSpecification": "string",
    "targetEnvironmentId": "string",
    "targetLifecycleStage": "string"
  }
}

Property Values

Microsoft.ApiCenter/services/workspaces/apiSources

Name Description Value
apiVersion The api version '2024-06-01-preview'
name The resource name string

Constraints:
Min length = 1
Max length = 90
Pattern = ^[a-zA-Z0-9-]{3,90}$ (required)
properties The resource-specific properties for this resource. ApiSourceProperties
type The resource type 'Microsoft.ApiCenter/services/workspaces/apiSources'

ApiSourceProperties

Name Description Value
azureApiManagementSource API source configuration for Azure API Management. AzureApiManagementSource
importSpecification Indicates if the specification should be imported along with metadata. 'always'
'never'
'ondemand'
targetEnvironmentId The target environment resource ID. string
targetLifecycleStage The target lifecycle stage. 'deprecated'
'design'
'development'
'preview'
'production'
'retired'
'testing'

AzureApiManagementSource

Name Description Value
msiResourceId The resource ID of the managed identity that has access to the API Management instance. string
resourceId API Management service resource ID. string (required)

Terraform (AzAPI provider) resource definition

The services/workspaces/apiSources resource type can be deployed with operations that target:

  • Resource groups For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.ApiCenter/services/workspaces/apiSources resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiCenter/services/workspaces/apiSources@2024-06-01-preview"
  name = "string"
  parent_id = "string"
  body = {
    properties = {
      azureApiManagementSource = {
        msiResourceId = "string"
        resourceId = "string"
      }
      importSpecification = "string"
      targetEnvironmentId = "string"
      targetLifecycleStage = "string"
    }
  }
}

Property Values

Microsoft.ApiCenter/services/workspaces/apiSources

Name Description Value
name The resource name string

Constraints:
Min length = 1
Max length = 90
Pattern = ^[a-zA-Z0-9-]{3,90}$ (required)
parent_id The ID of the resource that is the parent for this resource. ID for resource of type: services/workspaces
properties The resource-specific properties for this resource. ApiSourceProperties
type The resource type "Microsoft.ApiCenter/services/workspaces/apiSources@2024-06-01-preview"

ApiSourceProperties

Name Description Value
azureApiManagementSource API source configuration for Azure API Management. AzureApiManagementSource
importSpecification Indicates if the specification should be imported along with metadata. 'always'
'never'
'ondemand'
targetEnvironmentId The target environment resource ID. string
targetLifecycleStage The target lifecycle stage. 'deprecated'
'design'
'development'
'preview'
'production'
'retired'
'testing'

AzureApiManagementSource

Name Description Value
msiResourceId The resource ID of the managed identity that has access to the API Management instance. string
resourceId API Management service resource ID. string (required)
  • Last updated on