Api Version Set - Create Or Update

Membuat atau Memperbarui Kumpulan Versi Api.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apiVersionSets/{versionSetId}?api-version=2021-08-01

Parameter URI

Name In Required Type Description
resourceGroupName
path True
  • string

Nama grup sumber daya.

serviceName
path True
  • string

Nama layanan API Management.

Regex pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$

subscriptionId
path True
  • string

Kredensial langganan yang secara unik mengidentifikasi langganan Microsoft Azure. ID langganan membentuk bagian dari URI untuk setiap panggilan layanan.

versionSetId
path True
  • string

Pengidentifikasi Set Versi Api. Harus unik dalam instans layanan API Management saat ini.

Regex pattern: ^[^*#&+:<>?]+$

api-version
query True
  • string

Versi API yang akan digunakan dengan permintaan klien.

Header Permintaan

Name Required Type Description
If-Match
  • string

ETag Entitas. Tidak diperlukan saat membuat entitas, tetapi diperlukan saat memperbarui entitas.

Isi Permintaan

Name Required Type Description
properties.displayName True
  • string

Nama Set Versi API

properties.versioningScheme True

Nilai yang menentukan di mana pengidentifikasi Versi API akan berada dalam permintaan HTTP.

properties.description
  • string

Deskripsi Set Versi API.

properties.versionHeaderName
  • string

Nama parameter header HTTP yang menunjukkan Versi API jika versioningScheme diatur ke header.

properties.versionQueryName
  • string

Nama parameter kueri yang menunjukkan Versi API jika versioningScheme diatur ke query.

Respons

Name Type Description
200 OK

Set Versi Api berhasil diperbarui.

Headers

  • ETag: string
201 Created

Set Versi Api berhasil dibuat.

Headers

  • ETag: string
Other Status Codes

Respons kesalahan yang menjelaskan mengapa operasi gagal.

Keamanan

azure_auth

Azure Active Directory Flow OAuth2.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation meniru akun pengguna Anda

Contoh

ApiManagementCreateApiVersionSet

Sample Request

PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apiVersionSets/api1?api-version=2021-08-01

{
  "properties": {
    "displayName": "api set 1",
    "versioningScheme": "Segment",
    "description": "Version configuration"
  }
}

Sample Response

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apiVersionSets/api1",
  "type": "Microsoft.ApiManagement/service/api-version-sets",
  "name": "api1",
  "properties": {
    "displayName": "api set 1",
    "versioningScheme": "Segment",
    "description": "Version configuration"
  }
}
{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apiVersionSets/api1",
  "type": "Microsoft.ApiManagement/service/api-version-sets",
  "name": "api1",
  "properties": {
    "displayName": "api set 1",
    "versioningScheme": "Segment",
    "description": "Version configuration"
  }
}

Definisi

ApiVersionSetContract

Detail Kontrak Set Versi API.

ErrorFieldContract

Kontrak Bidang Kesalahan.

ErrorResponse

Respons Kesalahan.

versioningScheme

Nilai yang menentukan di mana pengidentifikasi Versi API akan berada dalam permintaan HTTP.

ApiVersionSetContract

Detail Kontrak Set Versi API.

Name Type Description
id
  • string

ID sumber daya yang sepenuhnya memenuhi syarat untuk sumber daya. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name
  • string

Nama sumber daya.

properties.description
  • string

Deskripsi Set Versi API.

properties.displayName
  • string

Nama Set Versi API

properties.versionHeaderName
  • string

Nama parameter header HTTP yang menunjukkan Versi API jika versioningScheme diatur ke header.

properties.versionQueryName
  • string

Nama parameter kueri yang menunjukkan Versi API jika versioningScheme diatur ke query.

properties.versioningScheme

Nilai yang menentukan di mana pengidentifikasi Versi API akan berada dalam permintaan HTTP.

type
  • string

Jenis sumber daya. Misalnya, "Microsoft.Compute/virtualMachines" atau "Microsoft. Storage/storageAccounts"

ErrorFieldContract

Kontrak Bidang Kesalahan.

Name Type Description
code
  • string

Kode kesalahan tingkat properti.

message
  • string

Representasi kesalahan tingkat properti yang dapat dibaca manusia.

target
  • string

Nama properti.

ErrorResponse

Respons Kesalahan.

Name Type Description
error.code
  • string

Kode kesalahan yang ditentukan layanan. Kode ini berfungsi sebagai sub-status untuk kode kesalahan HTTP yang ditentukan dalam respons.

error.details

Daftar bidang yang tidak valid dikirim dalam permintaan, jika terjadi kesalahan validasi.

error.message
  • string

Representasi kesalahan yang dapat dibaca manusia.

versioningScheme

Nilai yang menentukan di mana pengidentifikasi Versi API akan berada dalam permintaan HTTP.

Name Type Description
Header
  • string

Versi API diteruskan di header HTTP.

Query
  • string

Versi API diteruskan dalam parameter kueri.

Segment
  • string

Versi API diteruskan di segmen jalur.