ApiSchema interface
Gränssnitt som representerar ett ApiSchema.
Metoder
| begin |
Skapar eller uppdaterar schemakonfigurationen för API:et. |
| begin |
Skapar eller uppdaterar schemakonfigurationen för API:et. |
| delete(string, string, string, string, string, Api |
Tar bort schemakonfigurationen i API:et. |
| get(string, string, string, string, Api |
Hämta schemakonfigurationen på API-nivå. |
| get |
Hämtar entitetstillståndsversionen (Etag) för schemat som anges av dess identifierare. |
| list |
Hämta schemakonfigurationen på API-nivå. |
Metodinformation
beginCreateOrUpdate(string, string, string, string, SchemaContract, ApiSchemaCreateOrUpdateOptionalParams)
Skapar eller uppdaterar schemakonfigurationen för API:et.
function beginCreateOrUpdate(resourceGroupName: string, serviceName: string, apiId: string, schemaId: string, parameters: SchemaContract, options?: ApiSchemaCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<ApiSchemaCreateOrUpdateResponse>, ApiSchemaCreateOrUpdateResponse>>Parametrar
- resourceGroupName
-
string
Namnet på resursgruppen. Namnet är skiftlägesokänsligt.
- serviceName
-
string
Namnet på API Management-tjänsten.
- apiId
-
string
API-revisionsidentifierare. Måste vara unikt i den aktuella API Management tjänstinstansen. Icke-aktuell revision har ;rev=n som suffix där n är revisionsnumret.
- schemaId
-
string
Schema-ID-identifierare. Måste vara unikt i den aktuella API Management tjänstinstansen.
- parameters
- SchemaContract
Schemainnehållet som ska tillämpas.
Alternativparametrarna.
Returer
Promise<@azure/core-lro.SimplePollerLike<OperationState<ApiSchemaCreateOrUpdateResponse>, ApiSchemaCreateOrUpdateResponse>>
beginCreateOrUpdateAndWait(string, string, string, string, SchemaContract, ApiSchemaCreateOrUpdateOptionalParams)
Skapar eller uppdaterar schemakonfigurationen för API:et.
function beginCreateOrUpdateAndWait(resourceGroupName: string, serviceName: string, apiId: string, schemaId: string, parameters: SchemaContract, options?: ApiSchemaCreateOrUpdateOptionalParams): Promise<ApiSchemaCreateOrUpdateResponse>Parametrar
- resourceGroupName
-
string
Namnet på resursgruppen. Namnet är skiftlägesokänsligt.
- serviceName
-
string
Namnet på API Management-tjänsten.
- apiId
-
string
API-revisionsidentifierare. Måste vara unikt i den aktuella API Management tjänstinstansen. Icke-aktuell revision har ;rev=n som suffix där n är revisionsnumret.
- schemaId
-
string
Schema-ID-identifierare. Måste vara unikt i den aktuella API Management tjänstinstansen.
- parameters
- SchemaContract
Schemainnehållet som ska tillämpas.
Alternativparametrarna.
Returer
Promise<ApiSchemaCreateOrUpdateResponse>
delete(string, string, string, string, string, ApiSchemaDeleteOptionalParams)
Tar bort schemakonfigurationen i API:et.
function delete(resourceGroupName: string, serviceName: string, apiId: string, schemaId: string, ifMatch: string, options?: ApiSchemaDeleteOptionalParams): Promise<void>Parametrar
- resourceGroupName
-
string
Namnet på resursgruppen. Namnet är skiftlägesokänsligt.
- serviceName
-
string
Namnet på API Management-tjänsten.
- apiId
-
string
API-revisionsidentifierare. Måste vara unikt i den aktuella API Management tjänstinstansen. Icke-aktuell revision har ;rev=n som suffix där n är revisionsnumret.
- schemaId
-
string
Schema-ID-identifierare. Måste vara unikt i den aktuella API Management tjänstinstansen.
- ifMatch
-
string
ETag för entiteten. ETag ska matcha det aktuella entitetstillståndet från huvudsvaret för GET-begäran eller * för ovillkorlig uppdatering.
- options
- ApiSchemaDeleteOptionalParams
Alternativparametrarna.
Returer
Promise<void>
get(string, string, string, string, ApiSchemaGetOptionalParams)
Hämta schemakonfigurationen på API-nivå.
function get(resourceGroupName: string, serviceName: string, apiId: string, schemaId: string, options?: ApiSchemaGetOptionalParams): Promise<ApiSchemaGetResponse>Parametrar
- resourceGroupName
-
string
Namnet på resursgruppen. Namnet är skiftlägesokänsligt.
- serviceName
-
string
Namnet på API Management-tjänsten.
- apiId
-
string
API-revisionsidentifierare. Måste vara unikt i den aktuella API Management tjänstinstansen. Icke-aktuell revision har ;rev=n som suffix där n är revisionsnumret.
- schemaId
-
string
Schema-ID-identifierare. Måste vara unikt i den aktuella API Management tjänstinstansen.
- options
- ApiSchemaGetOptionalParams
Alternativparametrarna.
Returer
Promise<ApiSchemaGetResponse>
getEntityTag(string, string, string, string, ApiSchemaGetEntityTagOptionalParams)
Hämtar entitetstillståndsversionen (Etag) för schemat som anges av dess identifierare.
function getEntityTag(resourceGroupName: string, serviceName: string, apiId: string, schemaId: string, options?: ApiSchemaGetEntityTagOptionalParams): Promise<ApiSchemaGetEntityTagHeaders>Parametrar
- resourceGroupName
-
string
Namnet på resursgruppen. Namnet är skiftlägesokänsligt.
- serviceName
-
string
Namnet på API Management-tjänsten.
- apiId
-
string
API-revisionsidentifierare. Måste vara unikt i den aktuella API Management tjänstinstansen. Icke-aktuell revision har ;rev=n som suffix där n är revisionsnumret.
- schemaId
-
string
Schema-ID-identifierare. Måste vara unikt i den aktuella API Management tjänstinstansen.
Alternativparametrarna.
Returer
Promise<ApiSchemaGetEntityTagHeaders>
listByApi(string, string, string, ApiSchemaListByApiOptionalParams)
Hämta schemakonfigurationen på API-nivå.
function listByApi(resourceGroupName: string, serviceName: string, apiId: string, options?: ApiSchemaListByApiOptionalParams): PagedAsyncIterableIterator<SchemaContract, SchemaContract[], PageSettings>Parametrar
- resourceGroupName
-
string
Namnet på resursgruppen. Namnet är skiftlägesokänsligt.
- serviceName
-
string
Namnet på API Management-tjänsten.
- apiId
-
string
API-revisionsidentifierare. Måste vara unikt i den aktuella API Management tjänstinstansen. Icke-aktuell revision har ;rev=n som suffix där n är revisionsnumret.
- options
- ApiSchemaListByApiOptionalParams
Alternativparametrarna.