Subscription interface
Előfizetést jelképező felület.
Metódusok
Metódus adatai
createOrUpdate(string, string, string, SubscriptionCreateParameters, SubscriptionCreateOrUpdateOptionalParams)
Létrehozza vagy frissíti a megadott felhasználó előfizetését a megadott termékre.
function createOrUpdate(resourceGroupName: string, serviceName: string, sid: string, parameters: SubscriptionCreateParameters, options?: SubscriptionCreateOrUpdateOptionalParams): Promise<SubscriptionCreateOrUpdateResponse>Paraméterek
- resourceGroupName
-
string
Az erőforráscsoport neve. A név nem megkülönbözteti a kis- és nagybetűket.
- serviceName
-
string
Az API Management szolgáltatás neve.
- sid
-
string
Előfizetési entitás azonosítója. Az entitás egy felhasználó és egy termék közötti társítást jelöli az API Managementben.
- parameters
- SubscriptionCreateParameters
Paraméterek létrehozása.
A beállítások paraméterei.
Válaszok
Promise<SubscriptionCreateOrUpdateResponse>
delete(string, string, string, string, SubscriptionDeleteOptionalParams)
Törli a megadott előfizetést.
function delete(resourceGroupName: string, serviceName: string, sid: string, ifMatch: string, options?: SubscriptionDeleteOptionalParams): Promise<void>Paraméterek
- resourceGroupName
-
string
Az erőforráscsoport neve. A név nem megkülönbözteti a kis- és nagybetűket.
- serviceName
-
string
Az API Management szolgáltatás neve.
- sid
-
string
Előfizetési entitás azonosítója. Az entitás egy felhasználó és egy termék közötti társítást jelöli az API Managementben.
- ifMatch
-
string
Az entitás ETagje. Az ETag-nek meg kell egyeznie a GET-kérés fejlécválaszából származó aktuális entitásállapotmal, vagy * kell lennie a feltétel nélküli frissítéshez.
- options
- SubscriptionDeleteOptionalParams
A beállítások paraméterei.
Válaszok
Promise<void>
get(string, string, string, SubscriptionGetOptionalParams)
Lekéri a megadott előfizetési entitást.
function get(resourceGroupName: string, serviceName: string, sid: string, options?: SubscriptionGetOptionalParams): Promise<SubscriptionGetResponse>Paraméterek
- resourceGroupName
-
string
Az erőforráscsoport neve. A név nem megkülönbözteti a kis- és nagybetűket.
- serviceName
-
string
Az API Management szolgáltatás neve.
- sid
-
string
Előfizetési entitás azonosítója. Az entitás egy felhasználó és egy termék közötti társítást jelöli az API Managementben.
- options
- SubscriptionGetOptionalParams
A beállítások paraméterei.
Válaszok
Promise<SubscriptionGetResponse>
getEntityTag(string, string, string, SubscriptionGetEntityTagOptionalParams)
Lekéri az apimanagement-előfizetés entitásállapotának (Etag) verzióját, amelyet az azonosítója határoz meg.
function getEntityTag(resourceGroupName: string, serviceName: string, sid: string, options?: SubscriptionGetEntityTagOptionalParams): Promise<SubscriptionGetEntityTagHeaders>Paraméterek
- resourceGroupName
-
string
Az erőforráscsoport neve. A név nem megkülönbözteti a kis- és nagybetűket.
- serviceName
-
string
Az API Management szolgáltatás neve.
- sid
-
string
Előfizetési entitás azonosítója. Az entitás egy felhasználó és egy termék közötti társítást jelöli az API Managementben.
A beállítások paraméterei.
Válaszok
Promise<SubscriptionGetEntityTagHeaders>
list(string, string, SubscriptionListOptionalParams)
Az API Management szolgáltatáspéldány összes előfizetését listázza.
function list(resourceGroupName: string, serviceName: string, options?: SubscriptionListOptionalParams): PagedAsyncIterableIterator<SubscriptionContract, SubscriptionContract[], PageSettings>Paraméterek
- resourceGroupName
-
string
Az erőforráscsoport neve. A név nem megkülönbözteti a kis- és nagybetűket.
- serviceName
-
string
Az API Management szolgáltatás neve.
- options
- SubscriptionListOptionalParams
A beállítások paraméterei.
Válaszok
listSecrets(string, string, string, SubscriptionListSecretsOptionalParams)
Lekéri a megadott előfizetési kulcsokat.
function listSecrets(resourceGroupName: string, serviceName: string, sid: string, options?: SubscriptionListSecretsOptionalParams): Promise<SubscriptionListSecretsResponse>Paraméterek
- resourceGroupName
-
string
Az erőforráscsoport neve. A név nem megkülönbözteti a kis- és nagybetűket.
- serviceName
-
string
Az API Management szolgáltatás neve.
- sid
-
string
Előfizetési entitás azonosítója. Az entitás egy felhasználó és egy termék közötti társítást jelöli az API Managementben.
A beállítások paraméterei.
Válaszok
Promise<SubscriptionListSecretsResponse>
regeneratePrimaryKey(string, string, string, SubscriptionRegeneratePrimaryKeyOptionalParams)
Újragenerálja az API Management szolgáltatáspéldány meglévő előfizetésének elsődleges kulcsát.
function regeneratePrimaryKey(resourceGroupName: string, serviceName: string, sid: string, options?: SubscriptionRegeneratePrimaryKeyOptionalParams): Promise<void>Paraméterek
- resourceGroupName
-
string
Az erőforráscsoport neve. A név nem megkülönbözteti a kis- és nagybetűket.
- serviceName
-
string
Az API Management szolgáltatás neve.
- sid
-
string
Előfizetési entitás azonosítója. Az entitás egy felhasználó és egy termék közötti társítást jelöli az API Managementben.
A beállítások paraméterei.
Válaszok
Promise<void>
regenerateSecondaryKey(string, string, string, SubscriptionRegenerateSecondaryKeyOptionalParams)
Újragenerálja az API Management szolgáltatáspéldány meglévő előfizetésének másodlagos kulcsát.
function regenerateSecondaryKey(resourceGroupName: string, serviceName: string, sid: string, options?: SubscriptionRegenerateSecondaryKeyOptionalParams): Promise<void>Paraméterek
- resourceGroupName
-
string
Az erőforráscsoport neve. A név nem megkülönbözteti a kis- és nagybetűket.
- serviceName
-
string
Az API Management szolgáltatás neve.
- sid
-
string
Előfizetési entitás azonosítója. Az entitás egy felhasználó és egy termék közötti társítást jelöli az API Managementben.
A beállítások paraméterei.
Válaszok
Promise<void>
update(string, string, string, string, SubscriptionUpdateParameters, SubscriptionUpdateOptionalParams)
Frissíti az azonosító által megadott előfizetés részleteit.
function update(resourceGroupName: string, serviceName: string, sid: string, ifMatch: string, parameters: SubscriptionUpdateParameters, options?: SubscriptionUpdateOptionalParams): Promise<SubscriptionUpdateResponse>Paraméterek
- resourceGroupName
-
string
Az erőforráscsoport neve. A név nem megkülönbözteti a kis- és nagybetűket.
- serviceName
-
string
Az API Management szolgáltatás neve.
- sid
-
string
Előfizetési entitás azonosítója. Az entitás egy felhasználó és egy termék közötti társítást jelöli az API Managementben.
- ifMatch
-
string
Az entitás ETagje. Az ETag-nek meg kell egyeznie a GET-kérés fejlécválaszából származó aktuális entitásállapotmal, vagy * kell lennie a feltétel nélküli frissítéshez.
- parameters
- SubscriptionUpdateParameters
Paraméterek frissítése.
- options
- SubscriptionUpdateOptionalParams
A beállítások paraméterei.
Válaszok
Promise<SubscriptionUpdateResponse>