Api Version Set - Create Or Update
Erstellt oder aktualisiert eine API-Versionsgruppe
PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apiVersionSets/{versionSetId}?api-version=2022-08-01
URI-Parameter
Name | In | Erforderlich | Typ | Beschreibung |
---|---|---|---|---|
resource
|
path | True |
string |
Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet. |
service
|
path | True |
string |
Der Name des API Management-Diensts. Regex pattern: |
subscription
|
path | True |
string |
Hierbei handelt es sich um die ID des Zielabonnements. |
version
|
path | True |
string |
API-Versionssatzbezeichner. Muss im aktuellen API Management-Dienst instance eindeutig sein. Regex pattern: |
api-version
|
query | True |
string |
Hierbei handelt es sich um die für diesen Vorgang zu verwendende API-Version. |
Anforderungsheader
Name | Erforderlich | Typ | Beschreibung |
---|---|---|---|
If-Match |
string |
ETag der Entität. Nicht erforderlich beim Erstellen einer Entität, aber erforderlich beim Aktualisieren einer Entität. |
Anforderungstext
Name | Erforderlich | Typ | Beschreibung |
---|---|---|---|
properties.displayName | True |
string |
Name des API-Versionssatzes |
properties.versioningScheme | True |
Ein -Wert, der bestimmt, wo sich der API-Versionsbezeichner in einer HTTP-Anforderung befindet. |
|
properties.description |
string |
Beschreibung des API-Versionssatzes. |
|
properties.versionHeaderName |
string |
Name des HTTP-Headerparameters, der die API-Version angibt, wenn versioningScheme auf |
|
properties.versionQueryName |
string |
Name des Abfrageparameters, der die API-Version angibt, wenn versioningScheme auf |
Antworten
Name | Typ | Beschreibung |
---|---|---|
200 OK |
Der API-Versionssatz wurde erfolgreich aktualisiert. Headers ETag: string |
|
201 Created |
Der API-Versionssatz wurde erfolgreich erstellt. Headers ETag: string |
|
Other Status Codes |
Fehlerantwort mit Beschreibung des Grunds für den Fehler. |
Sicherheit
azure_auth
Azure Active Directory OAuth2-Flow.
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Name | Beschreibung |
---|---|
user_impersonation | Identitätswechsel Ihres Benutzerkontos |
Beispiele
ApiManagementCreateApiVersionSet
Sample Request
PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apiVersionSets/api1?api-version=2022-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"
}
}
Definitionen
Name | Beschreibung |
---|---|
Api |
Details zum API-Versionssatzvertrag. |
Error |
Fehler Feldvertrag. |
Error |
Fehlerantwort. |
versioning |
Ein -Wert, der bestimmt, wo sich der API-Versionsbezeichner in einer HTTP-Anforderung befindet. |
ApiVersionSetContract
Details zum API-Versionssatzvertrag.
Name | Typ | Beschreibung |
---|---|---|
id |
string |
Vollqualifizierte Ressourcen-ID für die Ressource. Beispiel: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
name |
string |
Der Name der Ressource |
properties.description |
string |
Beschreibung des API-Versionssatzes. |
properties.displayName |
string |
Name des API-Versionssatzes |
properties.versionHeaderName |
string |
Name des HTTP-Headerparameters, der die API-Version angibt, wenn versioningScheme auf |
properties.versionQueryName |
string |
Name des Abfrageparameters, der die API-Version angibt, wenn versioningScheme auf |
properties.versioningScheme |
Ein -Wert, der bestimmt, wo sich der API-Versionsbezeichner in einer HTTP-Anforderung befindet. |
|
type |
string |
Der Typ der Ressource. Z.B. "Microsoft.Compute/virtualMachines" oder "Microsoft.Storage/storageAccounts" |
ErrorFieldContract
Fehler Feldvertrag.
Name | Typ | Beschreibung |
---|---|---|
code |
string |
Fehlercode auf Eigenschaftsebene. |
message |
string |
Für Menschen lesbare Darstellung eines Fehlers auf Eigenschaftsebene. |
target |
string |
Der Eigenschaftsname. |
ErrorResponse
Fehlerantwort.
Name | Typ | Beschreibung |
---|---|---|
error.code |
string |
Der vom Dienst definierte Fehlercode. Dieser Code dient als Unterstatus für den in der Antwort angegebenen HTTP-Fehlercode. |
error.details |
Die Liste der ungültigen Felder, die in der Anforderung gesendet werden, im Falle eines Validierungsfehlers. |
|
error.message |
string |
Lesbare Darstellung des Fehlers. |
versioningScheme
Ein -Wert, der bestimmt, wo sich der API-Versionsbezeichner in einer HTTP-Anforderung befindet.
Name | Typ | Beschreibung |
---|---|---|
Header |
string |
Die API-Version wird in einem HTTP-Header übergeben. |
Query |
string |
Die API-Version wird in einem Abfrageparameter übergeben. |
Segment |
string |
Die API-Version wird in einem Pfadsegment übergeben. |