Not
Bu sayfaya erişim yetkilendirme gerektiriyor. Oturum açmayı veya dizinleri değiştirmeyi deneyebilirsiniz.
Bu sayfaya erişim yetkilendirme gerektiriyor. Dizinleri değiştirmeyi deneyebilirsiniz.
Bicep kaynak tanımı
Hizmet/çalışma alanları/apis/işlemler kaynak türü, aşağıdakileri hedefleyen işlemlerle dağıtılabilir:
- kaynak grupları
- Bkz. kaynak grubu dağıtım komutları
Her API sürümünde değiştirilen özelliklerin listesi için bkz. değişiklik günlüğü.
Kullanım Örnekleri
Azure Doğrulanmış Modülleri
Aşağıdaki Azure Doğrulanmış Modüller bu kaynak türünü dağıtmak için kullanılabilir.
| Module | Açıklama |
|---|---|
| API Yönetim Servisi - Çalışma Alanı - API - Operasyon | API Yönetim Hizmeti için AVM Child Modülü - Çalışma Alanı - API - Operasyon |
Kaynak biçimi
Microsoft.ApiManagement/service/workspaces/apis/operations kaynağı oluşturmak için şablonunuza aşağıdaki Bicep'i ekleyin.
resource symbolicname 'Microsoft.ApiManagement/service/workspaces/apis/operations@2024-05-01' = {
parent: resourceSymbolicName
name: 'string'
properties: {
description: 'string'
displayName: 'string'
method: 'string'
policies: 'string'
request: {
description: 'string'
headers: [
{
defaultValue: 'string'
description: 'string'
examples: {
{customized property}: {
description: 'string'
externalValue: 'string'
summary: 'string'
value: any(...)
}
}
name: 'string'
required: bool
schemaId: 'string'
type: 'string'
typeName: 'string'
values: [
'string'
]
}
]
queryParameters: [
{
defaultValue: 'string'
description: 'string'
examples: {
{customized property}: {
description: 'string'
externalValue: 'string'
summary: 'string'
value: any(...)
}
}
name: 'string'
required: bool
schemaId: 'string'
type: 'string'
typeName: 'string'
values: [
'string'
]
}
]
representations: [
{
contentType: 'string'
examples: {
{customized property}: {
description: 'string'
externalValue: 'string'
summary: 'string'
value: any(...)
}
}
formParameters: [
{
defaultValue: 'string'
description: 'string'
examples: {
{customized property}: {
description: 'string'
externalValue: 'string'
summary: 'string'
value: any(...)
}
}
name: 'string'
required: bool
schemaId: 'string'
type: 'string'
typeName: 'string'
values: [
'string'
]
}
]
schemaId: 'string'
typeName: 'string'
}
]
}
responses: [
{
description: 'string'
headers: [
{
defaultValue: 'string'
description: 'string'
examples: {
{customized property}: {
description: 'string'
externalValue: 'string'
summary: 'string'
value: any(...)
}
}
name: 'string'
required: bool
schemaId: 'string'
type: 'string'
typeName: 'string'
values: [
'string'
]
}
]
representations: [
{
contentType: 'string'
examples: {
{customized property}: {
description: 'string'
externalValue: 'string'
summary: 'string'
value: any(...)
}
}
formParameters: [
{
defaultValue: 'string'
description: 'string'
examples: {
{customized property}: {
description: 'string'
externalValue: 'string'
summary: 'string'
value: any(...)
}
}
name: 'string'
required: bool
schemaId: 'string'
type: 'string'
typeName: 'string'
values: [
'string'
]
}
]
schemaId: 'string'
typeName: 'string'
}
]
statusCode: int
}
]
templateParameters: [
{
defaultValue: 'string'
description: 'string'
examples: {
{customized property}: {
description: 'string'
externalValue: 'string'
summary: 'string'
value: any(...)
}
}
name: 'string'
required: bool
schemaId: 'string'
type: 'string'
typeName: 'string'
values: [
'string'
]
}
]
urlTemplate: 'string'
}
}
Özellik Değerleri
Microsoft.ApiManagement/service/workspaces/apis/operations
| Ad | Açıklama | Değer |
|---|---|---|
| ad | Kaynak adı | dizgi Kısıtlama -ları: En az uzunluk = 1 Maksimum uzunluk = 80 (gerekli) |
| ebeveyn | Bicep'te bir alt kaynak için üst kaynak belirtebilirsiniz. Bu özelliği yalnızca alt kaynak üst kaynağın dışında bildirildiğinde eklemeniz gerekir. Daha fazla bilgi için bkz. Alt kaynaküst kaynak dışında. |
Kaynak türü için sembolik ad: hizmeti/çalışma alanları/apis |
| Özellikler | İşlem Sözleşmesinin Özellikleri. | OperationContractProperties |
OperationContractProperties
| Ad | Açıklama | Değer |
|---|---|---|
| Açıklama | İşlemin açıklaması. HTML biçimlendirme etiketleri içerebilir. | dizgi Kısıtlama -ları: Maksimum uzunluk = 1000 |
| ekran adı | İşlem Adı. | dizgi Kısıtlama -ları: En az uzunluk = 1 Maksimum uzunluk = 300 (gerekli) |
| yöntem | Geçerli bir HTTP İşlem Yöntemi. GET, PUT, POST gibi tipik Http Yöntemleri ancak yalnızca bunlarla sınırlı değildir. | dize (gerekli) |
| Koşullarıdır | İşlem İlkeleri | dizgi |
| istek | İstek ayrıntılarını içeren bir varlık. | requestContract |
| Yanıt | İşlem yanıtları dizisi. | ResponseContract[] |
| templateParameters | URL şablonu parametrelerinin koleksiyonu. | ParameterContract[] |
| urlTemplate | Bu işlem için hedef kaynağı tanımlayan göreli URL şablonu. Parametreleri içerebilir. Örnek: /customers/{cid}/orders/{oid}/?date={date} | dizgi Kısıtlama -ları: En az uzunluk = 1 Maksimum uzunluk = 1000 (gerekli) |
ParameterContract
| Ad | Açıklama | Değer |
|---|---|---|
| varsayılan değer | Varsayılan parametre değeri. | dizgi |
| Açıklama | Parametre açıklaması. | dizgi |
| Örnekler | Parametresi için tanımlanan örnek. | ParameterExamplesContract |
| ad | Parametre adı. | dize (gerekli) |
| Gerekli | Parametrenin gerekli olup olmadığını belirtir. | Bool |
| schemaId | Şema tanımlayıcısı. | dizgi |
| tür | Parametre türü. | dize (gerekli) |
| typeName | Şema tarafından tanımlanan tür adı. | dizgi |
| Değer | Parametre değerleri. | string[] |
ParameterExampleContract
| Ad | Açıklama | Değer |
|---|---|---|
| Açıklama | Örnek için uzun açıklama | dizgi |
| externalValue | Değişmez değer örneğine işaret eden BIR URL | dizgi |
| özet | Örnek için kısa açıklama | dizgi |
| değer | Örnek değer. İlkel bir değer veya nesne olabilir. | herhangi |
ParameterExamplesContract
| Ad | Açıklama | Değer |
|---|
ParameterExamplesContract
| Ad | Açıklama | Değer |
|---|
RepresentationContract
| Ad | Açıklama | Değer |
|---|---|---|
| içerik türü | Bu gösterim için kayıtlı veya özel içerik türünü belirtir; örneğin, uygulama/xml. | dize (gerekli) |
| Örnekler | Gösterim için tanımlanan örnek. | ParameterExamplesContract |
| formParameters | Form parametreleri koleksiyonu. 'contentType' değeri 'application/x-www-form-urlencoded' veya 'multipart/form-data' ise gereklidir... | ParameterContract[] |
| schemaId | Şema tanımlayıcısı. Yalnızca 'contentType' değeri 'application/x-www-form-urlencoded' veya 'multipart/form-data' değilse geçerlidir. | dizgi |
| typeName | Şema tarafından tanımlanan tür adı. Yalnızca 'contentType' değeri 'application/x-www-form-urlencoded' veya 'multipart/form-data' değilse geçerlidir. | dizgi |
RequestContract
| Ad | Açıklama | Değer |
|---|---|---|
| Açıklama | İşlem isteği açıklaması. | dizgi |
| Üstbilgi | İşlem isteği üst bilgileri koleksiyonu. | ParameterContract[] |
| queryParameters | İşlem isteği sorgu parametrelerinin koleksiyonu. | ParameterContract[] |
| Temsil | İşlem isteği gösterimlerinin koleksiyonu. | RepresentationContract[] |
ResponseContract
| Ad | Açıklama | Değer |
|---|---|---|
| Açıklama | İşlem yanıtı açıklaması. | dizgi |
| Üstbilgi | İşlem yanıtı üst bilgileri koleksiyonu. | ParameterContract[] |
| Temsil | İşlem yanıtı gösterimlerinin koleksiyonu. | RepresentationContract[] |
| statusCode | İşlem yanıtı HTTP durum kodu. | int (gerekli) |
ARM şablonu kaynak tanımı
Hizmet/çalışma alanları/apis/işlemler kaynak türü, aşağıdakileri hedefleyen işlemlerle dağıtılabilir:
- Kaynak grupları - Kaynak grubu dağıtım komutlarına bakınız Her API sürümünde değişen özelliklerin listesi için değişiklik günlüğüne bakınız.
Kullanım Örnekleri
Kaynak biçimi
Microsoft.ApiManagement/service/workspaces/apis/operations kaynağı oluşturmak için şablonunuza aşağıdaki JSON'u ekleyin.
{
"type": "Microsoft.ApiManagement/service/workspaces/apis/operations",
"apiVersion": "2024-05-01",
"name": "string",
"properties": {
"description": "string",
"displayName": "string",
"method": "string",
"policies": "string",
"request": {
"description": "string",
"headers": [
{
"defaultValue": "string",
"description": "string",
"examples": {
"{customized property}": {
"description": "string",
"externalValue": "string",
"summary": "string",
"value": {}
}
},
"name": "string",
"required": "bool",
"schemaId": "string",
"type": "string",
"typeName": "string",
"values": [ "string" ]
}
],
"queryParameters": [
{
"defaultValue": "string",
"description": "string",
"examples": {
"{customized property}": {
"description": "string",
"externalValue": "string",
"summary": "string",
"value": {}
}
},
"name": "string",
"required": "bool",
"schemaId": "string",
"type": "string",
"typeName": "string",
"values": [ "string" ]
}
],
"representations": [
{
"contentType": "string",
"examples": {
"{customized property}": {
"description": "string",
"externalValue": "string",
"summary": "string",
"value": {}
}
},
"formParameters": [
{
"defaultValue": "string",
"description": "string",
"examples": {
"{customized property}": {
"description": "string",
"externalValue": "string",
"summary": "string",
"value": {}
}
},
"name": "string",
"required": "bool",
"schemaId": "string",
"type": "string",
"typeName": "string",
"values": [ "string" ]
}
],
"schemaId": "string",
"typeName": "string"
}
]
},
"responses": [
{
"description": "string",
"headers": [
{
"defaultValue": "string",
"description": "string",
"examples": {
"{customized property}": {
"description": "string",
"externalValue": "string",
"summary": "string",
"value": {}
}
},
"name": "string",
"required": "bool",
"schemaId": "string",
"type": "string",
"typeName": "string",
"values": [ "string" ]
}
],
"representations": [
{
"contentType": "string",
"examples": {
"{customized property}": {
"description": "string",
"externalValue": "string",
"summary": "string",
"value": {}
}
},
"formParameters": [
{
"defaultValue": "string",
"description": "string",
"examples": {
"{customized property}": {
"description": "string",
"externalValue": "string",
"summary": "string",
"value": {}
}
},
"name": "string",
"required": "bool",
"schemaId": "string",
"type": "string",
"typeName": "string",
"values": [ "string" ]
}
],
"schemaId": "string",
"typeName": "string"
}
],
"statusCode": "int"
}
],
"templateParameters": [
{
"defaultValue": "string",
"description": "string",
"examples": {
"{customized property}": {
"description": "string",
"externalValue": "string",
"summary": "string",
"value": {}
}
},
"name": "string",
"required": "bool",
"schemaId": "string",
"type": "string",
"typeName": "string",
"values": [ "string" ]
}
],
"urlTemplate": "string"
}
}
Özellik Değerleri
Microsoft.ApiManagement/service/workspaces/apis/operations
| Ad | Açıklama | Değer |
|---|---|---|
| apiVersiyonu | API sürümü | '2024-05-01' |
| ad | Kaynak adı | dizgi Kısıtlama -ları: En az uzunluk = 1 Maksimum uzunluk = 80 (gerekli) |
| Özellikler | İşlem Sözleşmesinin Özellikleri. | OperationContractProperties |
| tür | Kaynak türü | 'Microsoft.ApiManagement/service/workspaces/apis/operations' |
OperationContractProperties
| Ad | Açıklama | Değer |
|---|---|---|
| Açıklama | İşlemin açıklaması. HTML biçimlendirme etiketleri içerebilir. | dizgi Kısıtlama -ları: Maksimum uzunluk = 1000 |
| ekran adı | İşlem Adı. | dizgi Kısıtlama -ları: En az uzunluk = 1 Maksimum uzunluk = 300 (gerekli) |
| yöntem | Geçerli bir HTTP İşlem Yöntemi. GET, PUT, POST gibi tipik Http Yöntemleri ancak yalnızca bunlarla sınırlı değildir. | dize (gerekli) |
| Koşullarıdır | İşlem İlkeleri | dizgi |
| istek | İstek ayrıntılarını içeren bir varlık. | requestContract |
| Yanıt | İşlem yanıtları dizisi. | ResponseContract[] |
| templateParameters | URL şablonu parametrelerinin koleksiyonu. | ParameterContract[] |
| urlTemplate | Bu işlem için hedef kaynağı tanımlayan göreli URL şablonu. Parametreleri içerebilir. Örnek: /customers/{cid}/orders/{oid}/?date={date} | dizgi Kısıtlama -ları: En az uzunluk = 1 Maksimum uzunluk = 1000 (gerekli) |
ParameterContract
| Ad | Açıklama | Değer |
|---|---|---|
| varsayılan değer | Varsayılan parametre değeri. | dizgi |
| Açıklama | Parametre açıklaması. | dizgi |
| Örnekler | Parametresi için tanımlanan örnek. | ParameterExamplesContract |
| ad | Parametre adı. | dize (gerekli) |
| Gerekli | Parametrenin gerekli olup olmadığını belirtir. | Bool |
| schemaId | Şema tanımlayıcısı. | dizgi |
| tür | Parametre türü. | dize (gerekli) |
| typeName | Şema tarafından tanımlanan tür adı. | dizgi |
| Değer | Parametre değerleri. | string[] |
ParameterExampleContract
| Ad | Açıklama | Değer |
|---|---|---|
| Açıklama | Örnek için uzun açıklama | dizgi |
| externalValue | Değişmez değer örneğine işaret eden BIR URL | dizgi |
| özet | Örnek için kısa açıklama | dizgi |
| değer | Örnek değer. İlkel bir değer veya nesne olabilir. | herhangi |
ParameterExamplesContract
| Ad | Açıklama | Değer |
|---|
ParameterExamplesContract
| Ad | Açıklama | Değer |
|---|
RepresentationContract
| Ad | Açıklama | Değer |
|---|---|---|
| içerik türü | Bu gösterim için kayıtlı veya özel içerik türünü belirtir; örneğin, uygulama/xml. | dize (gerekli) |
| Örnekler | Gösterim için tanımlanan örnek. | ParameterExamplesContract |
| formParameters | Form parametreleri koleksiyonu. 'contentType' değeri 'application/x-www-form-urlencoded' veya 'multipart/form-data' ise gereklidir... | ParameterContract[] |
| schemaId | Şema tanımlayıcısı. Yalnızca 'contentType' değeri 'application/x-www-form-urlencoded' veya 'multipart/form-data' değilse geçerlidir. | dizgi |
| typeName | Şema tarafından tanımlanan tür adı. Yalnızca 'contentType' değeri 'application/x-www-form-urlencoded' veya 'multipart/form-data' değilse geçerlidir. | dizgi |
RequestContract
| Ad | Açıklama | Değer |
|---|---|---|
| Açıklama | İşlem isteği açıklaması. | dizgi |
| Üstbilgi | İşlem isteği üst bilgileri koleksiyonu. | ParameterContract[] |
| queryParameters | İşlem isteği sorgu parametrelerinin koleksiyonu. | ParameterContract[] |
| Temsil | İşlem isteği gösterimlerinin koleksiyonu. | RepresentationContract[] |
ResponseContract
| Ad | Açıklama | Değer |
|---|---|---|
| Açıklama | İşlem yanıtı açıklaması. | dizgi |
| Üstbilgi | İşlem yanıtı üst bilgileri koleksiyonu. | ParameterContract[] |
| Temsil | İşlem yanıtı gösterimlerinin koleksiyonu. | RepresentationContract[] |
| statusCode | İşlem yanıtı HTTP durum kodu. | int (gerekli) |
Terraform (AzAPI sağlayıcısı) kaynak tanımı
Hizmet/çalışma alanları/apis/işlemler kaynak türü, aşağıdakileri hedefleyen işlemlerle dağıtılabilir:
- Kaynak grupları Her API sürümünde değişen özelliklerin listesi için bkz. Değişiklik günlüğü.
Kaynak biçimi
Microsoft.ApiManagement/service/workspaces/apis/operations kaynağı oluşturmak için şablonunuza aşağıdaki Terraform'u ekleyin.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.ApiManagement/service/workspaces/apis/operations@2024-05-01"
name = "string"
parent_id = "string"
body = {
properties = {
description = "string"
displayName = "string"
method = "string"
policies = "string"
request = {
description = "string"
headers = [
{
defaultValue = "string"
description = "string"
examples = {
{customized property} = {
description = "string"
externalValue = "string"
summary = "string"
value = ?
}
}
name = "string"
required = bool
schemaId = "string"
type = "string"
typeName = "string"
values = [
"string"
]
}
]
queryParameters = [
{
defaultValue = "string"
description = "string"
examples = {
{customized property} = {
description = "string"
externalValue = "string"
summary = "string"
value = ?
}
}
name = "string"
required = bool
schemaId = "string"
type = "string"
typeName = "string"
values = [
"string"
]
}
]
representations = [
{
contentType = "string"
examples = {
{customized property} = {
description = "string"
externalValue = "string"
summary = "string"
value = ?
}
}
formParameters = [
{
defaultValue = "string"
description = "string"
examples = {
{customized property} = {
description = "string"
externalValue = "string"
summary = "string"
value = ?
}
}
name = "string"
required = bool
schemaId = "string"
type = "string"
typeName = "string"
values = [
"string"
]
}
]
schemaId = "string"
typeName = "string"
}
]
}
responses = [
{
description = "string"
headers = [
{
defaultValue = "string"
description = "string"
examples = {
{customized property} = {
description = "string"
externalValue = "string"
summary = "string"
value = ?
}
}
name = "string"
required = bool
schemaId = "string"
type = "string"
typeName = "string"
values = [
"string"
]
}
]
representations = [
{
contentType = "string"
examples = {
{customized property} = {
description = "string"
externalValue = "string"
summary = "string"
value = ?
}
}
formParameters = [
{
defaultValue = "string"
description = "string"
examples = {
{customized property} = {
description = "string"
externalValue = "string"
summary = "string"
value = ?
}
}
name = "string"
required = bool
schemaId = "string"
type = "string"
typeName = "string"
values = [
"string"
]
}
]
schemaId = "string"
typeName = "string"
}
]
statusCode = int
}
]
templateParameters = [
{
defaultValue = "string"
description = "string"
examples = {
{customized property} = {
description = "string"
externalValue = "string"
summary = "string"
value = ?
}
}
name = "string"
required = bool
schemaId = "string"
type = "string"
typeName = "string"
values = [
"string"
]
}
]
urlTemplate = "string"
}
}
}
Özellik Değerleri
Microsoft.ApiManagement/service/workspaces/apis/operations
| Ad | Açıklama | Değer |
|---|---|---|
| ad | Kaynak adı | dizgi Kısıtlama -ları: En az uzunluk = 1 Maksimum uzunluk = 80 (gerekli) |
| parent_id | Bu kaynağın üst öğesi olan kaynağın kimliği. | Tür kaynağı kimliği: hizmet/çalışma alanları/apis |
| Özellikler | İşlem Sözleşmesinin Özellikleri. | OperationContractProperties |
| tür | Kaynak türü | "Microsoft.ApiManagement/service/workspaces/apis/operations@2024-05-01" |
OperationContractProperties
| Ad | Açıklama | Değer |
|---|---|---|
| Açıklama | İşlemin açıklaması. HTML biçimlendirme etiketleri içerebilir. | dizgi Kısıtlama -ları: Maksimum uzunluk = 1000 |
| ekran adı | İşlem Adı. | dizgi Kısıtlama -ları: En az uzunluk = 1 Maksimum uzunluk = 300 (gerekli) |
| yöntem | Geçerli bir HTTP İşlem Yöntemi. GET, PUT, POST gibi tipik Http Yöntemleri ancak yalnızca bunlarla sınırlı değildir. | dize (gerekli) |
| Koşullarıdır | İşlem İlkeleri | dizgi |
| istek | İstek ayrıntılarını içeren bir varlık. | requestContract |
| Yanıt | İşlem yanıtları dizisi. | ResponseContract[] |
| templateParameters | URL şablonu parametrelerinin koleksiyonu. | ParameterContract[] |
| urlTemplate | Bu işlem için hedef kaynağı tanımlayan göreli URL şablonu. Parametreleri içerebilir. Örnek: /customers/{cid}/orders/{oid}/?date={date} | dizgi Kısıtlama -ları: En az uzunluk = 1 Maksimum uzunluk = 1000 (gerekli) |
ParameterContract
| Ad | Açıklama | Değer |
|---|---|---|
| varsayılan değer | Varsayılan parametre değeri. | dizgi |
| Açıklama | Parametre açıklaması. | dizgi |
| Örnekler | Parametresi için tanımlanan örnek. | ParameterExamplesContract |
| ad | Parametre adı. | dize (gerekli) |
| Gerekli | Parametrenin gerekli olup olmadığını belirtir. | Bool |
| schemaId | Şema tanımlayıcısı. | dizgi |
| tür | Parametre türü. | dize (gerekli) |
| typeName | Şema tarafından tanımlanan tür adı. | dizgi |
| Değer | Parametre değerleri. | string[] |
ParameterExampleContract
| Ad | Açıklama | Değer |
|---|---|---|
| Açıklama | Örnek için uzun açıklama | dizgi |
| externalValue | Değişmez değer örneğine işaret eden BIR URL | dizgi |
| özet | Örnek için kısa açıklama | dizgi |
| değer | Örnek değer. İlkel bir değer veya nesne olabilir. | herhangi |
ParameterExamplesContract
| Ad | Açıklama | Değer |
|---|
ParameterExamplesContract
| Ad | Açıklama | Değer |
|---|
RepresentationContract
| Ad | Açıklama | Değer |
|---|---|---|
| içerik türü | Bu gösterim için kayıtlı veya özel içerik türünü belirtir; örneğin, uygulama/xml. | dize (gerekli) |
| Örnekler | Gösterim için tanımlanan örnek. | ParameterExamplesContract |
| formParameters | Form parametreleri koleksiyonu. 'contentType' değeri 'application/x-www-form-urlencoded' veya 'multipart/form-data' ise gereklidir... | ParameterContract[] |
| schemaId | Şema tanımlayıcısı. Yalnızca 'contentType' değeri 'application/x-www-form-urlencoded' veya 'multipart/form-data' değilse geçerlidir. | dizgi |
| typeName | Şema tarafından tanımlanan tür adı. Yalnızca 'contentType' değeri 'application/x-www-form-urlencoded' veya 'multipart/form-data' değilse geçerlidir. | dizgi |
RequestContract
| Ad | Açıklama | Değer |
|---|---|---|
| Açıklama | İşlem isteği açıklaması. | dizgi |
| Üstbilgi | İşlem isteği üst bilgileri koleksiyonu. | ParameterContract[] |
| queryParameters | İşlem isteği sorgu parametrelerinin koleksiyonu. | ParameterContract[] |
| Temsil | İşlem isteği gösterimlerinin koleksiyonu. | RepresentationContract[] |
ResponseContract
| Ad | Açıklama | Değer |
|---|---|---|
| Açıklama | İşlem yanıtı açıklaması. | dizgi |
| Üstbilgi | İşlem yanıtı üst bilgileri koleksiyonu. | ParameterContract[] |
| Temsil | İşlem yanıtı gösterimlerinin koleksiyonu. | RepresentationContract[] |
| statusCode | İşlem yanıtı HTTP durum kodu. | int (gerekli) |