Microsoft.ApiManagement service/tenant 2023-03-01-preview
Bicep resource definition
The service/tenant resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.ApiManagement/service/tenant resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.ApiManagement/service/tenant@2023-03-01-preview' = {
parent: resourceSymbolicName
name: 'string'
properties: {
enabled: bool
primaryKey: 'string'
principalId: 'string'
secondaryKey: 'string'
}
}
Property values
AccessInformationCreateParameterPropertiesOrAccessInformationContractProperties
| Name | Description | Value |
|---|---|---|
| enabled | Determines whether direct access is enabled. | bool |
| primaryKey | Primary access key. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value. | string Constraints: Sensitive value. Pass in as a secure parameter. |
| principalId | Principal (User) Identifier. | string |
| secondaryKey | Secondary access key. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value. | string Constraints: Sensitive value. Pass in as a secure parameter. |
Microsoft.ApiManagement/service/tenant
| Name | Description | Value |
|---|---|---|
| name | The resource name | 'access' 'gitAccess' (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: service |
| properties | Tenant access information update parameter properties. | AccessInformationCreateParameterPropertiesOrAccessInformationContractProperties |
ARM template resource definition
The service/tenant resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.ApiManagement/service/tenant resource, add the following JSON to your template.
{
"type": "Microsoft.ApiManagement/service/tenant",
"apiVersion": "2023-03-01-preview",
"name": "string",
"properties": {
"enabled": "bool",
"primaryKey": "string",
"principalId": "string",
"secondaryKey": "string"
}
}
Property values
AccessInformationCreateParameterPropertiesOrAccessInformationContractProperties
| Name | Description | Value |
|---|---|---|
| enabled | Determines whether direct access is enabled. | bool |
| primaryKey | Primary access key. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value. | string Constraints: Sensitive value. Pass in as a secure parameter. |
| principalId | Principal (User) Identifier. | string |
| secondaryKey | Secondary access key. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value. | string Constraints: Sensitive value. Pass in as a secure parameter. |
Microsoft.ApiManagement/service/tenant
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2023-03-01-preview' |
| name | The resource name | 'access' 'gitAccess' (required) |
| properties | Tenant access information update parameter properties. | AccessInformationCreateParameterPropertiesOrAccessInformationContractProperties |
| type | The resource type | 'Microsoft.ApiManagement/service/tenant' |
Terraform (AzAPI provider) resource definition
The service/tenant 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.ApiManagement/service/tenant resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.ApiManagement/service/tenant@2023-03-01-preview"
name = "string"
body = jsonencode({
properties = {
enabled = bool
primaryKey = "string"
principalId = "string"
secondaryKey = "string"
}
})
}
Property values
AccessInformationCreateParameterPropertiesOrAccessInformationContractProperties
| Name | Description | Value |
|---|---|---|
| enabled | Determines whether direct access is enabled. | bool |
| primaryKey | Primary access key. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value. | string Constraints: Sensitive value. Pass in as a secure parameter. |
| principalId | Principal (User) Identifier. | string |
| secondaryKey | Secondary access key. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value. | string Constraints: Sensitive value. Pass in as a secure parameter. |
Microsoft.ApiManagement/service/tenant
| Name | Description | Value |
|---|---|---|
| name | The resource name | 'access' 'gitAccess' (required) |
| parent_id | The ID of the resource that is the parent for this resource. | ID for resource of type: service |
| properties | Tenant access information update parameter properties. | AccessInformationCreateParameterPropertiesOrAccessInformationContractProperties |
| type | The resource type | "Microsoft.ApiManagement/service/tenant@2023-03-01-preview" |