Invoke-AzRestMethod
Skapa och utföra HTTP-begäran endast till Azure-resurshanteringsslutpunkten
Syntax
Invoke-AzRestMethod
-Path <String>
[-Method <String>]
[-Payload <String>]
[-AsJob]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Invoke-AzRestMethod
[-SubscriptionId <String>]
[-ResourceGroupName <String>]
[-ResourceProviderName <String>]
[-ResourceType <String[]>]
[-Name <String[]>]
-ApiVersion <String>
[-Method <String>]
[-Payload <String>]
[-AsJob]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Invoke-AzRestMethod
[-Uri] <Uri>
[-ResourceId <Uri>]
[-Method <String>]
[-Payload <String>]
[-AsJob]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Description
Skapa och utföra HTTP-begäran endast till Azure-resurshanteringsslutpunkten
Exempel
Exempel 1
Invoke-AzRestMethod -Path "/subscriptions/{subscription}/resourcegroups/{resourcegroup}/providers/microsoft.operationalinsights/workspaces/{workspace}?api-version={API}" -Method GET
Headers : {[Cache-Control, System.String[]], [Pragma, System.String[]], [x-ms-request-id, System.String[]], [Strict-Transport-Security, System.String[]]…}
Version : 1.1
StatusCode : 200
Method : GET
Content : {
"properties": {
"source": "Azure",
"customerId": "{customerId}",
"provisioningState": "Succeeded",
"sku": {
"name": "pergb2018",
"maxCapacityReservationLevel": 3000,
"lastSkuUpdate": "Mon, 25 May 2020 11:10:01 GMT"
},
"retentionInDays": 30,
"features": {
"legacy": 0,
"searchVersion": 1,
"enableLogAccessUsingOnlyResourcePermissions": true
},
"workspaceCapping": {
"dailyQuotaGb": -1.0,
"quotaNextResetTime": "Thu, 18 Jun 2020 05:00:00 GMT",
"dataIngestionStatus": "RespectQuota"
},
"enableFailover": false,
"publicNetworkAccessForIngestion": "Enabled",
"publicNetworkAccessForQuery": "Enabled",
"createdDate": "Mon, 25 May 2020 11:10:01 GMT",
"modifiedDate": "Mon, 25 May 2020 11:10:02 GMT"
},
"id": "/subscriptions/{subscription}/resourcegroups/{resourcegroup}/providers/microsoft.operationalinsights/workspaces/{workspace}",
"name": "{workspace}",
"type": "Microsoft.OperationalInsights/workspaces",
"location": "eastasia",
"tags": {}
}Hämta log analytics-arbetsytan efter sökväg. Det stöder endast API för hanteringsplan och Värdnamn för Azure Resource Manager läggs till enligt miljöinställningen i Azure.
Exempel 2
Invoke-AzRestMethod https://graph.microsoft.com/v1.0/me
Headers : {[Date, System.String[]], [Cache-Control, System.String[]], [Transfer-Encoding, System.String[]], [Strict-Transport-Security, System.String[]]…}
Version : 1.1
StatusCode : 200
Method : GET
Content : {"@odata.context":"https://graph.microsoft.com/v1.0/$metadata#users/$entity","businessPhones":["......}Hämta aktuell inloggad användare via MicrosoftGraph API. Det här exemplet motsvarar Get-AzADUser -SignedIn.
Exempel 3
$subscriptionId = (Get-AzContext).Subscription.ID
Invoke-AzRestMethod -SubscriptionId $subscriptionId -ResourceGroupName "test-group" -ResourceProviderName Microsoft.AppPlatform -ResourceType Spring,apps -Name "test-spring-service" -ApiVersion 2020-07-01 -Method GET
Headers : {[Cache-Control, System.String[]], [Pragma, System.String[]], [Vary, System.String[]], [x-ms-request-id,
System.String[]]…}
Version : 1.1
StatusCode : 200
Method : GET
Content : {"value":[{"properties":{"public":true,"url":"https://test-spring-service-demo.azuremicroservices.io","provisioni
ngState":"Succeeded","activeDeploymentName":"default","fqdn":"test-spring-service.azuremicroservices.io","httpsOn
ly":false,"createdTime":"2022-06-22T02:57:13.272Z","temporaryDisk":{"sizeInGB":5,"mountPath":"/tmp"},"pers
istentDisk":{"sizeInGB":0,"mountPath":"/persistent"}},"type":"Microsoft.AppPlatform/Spring/apps","identity
":null,"location":"eastus","id":"/subscriptions/$subscriptionId/resourceGroups/test-group/providers/Microsoft.AppPlatform/Spring/test-spring-service/apps/demo","name":"demo"},{"properties":{"publ
ic":false,"provisioningState":"Succeeded","activeDeploymentName":"deploy01","fqdn":"test-spring-service.azuremicr
oservices.io","httpsOnly":false,"createdTime":"2022-06-22T07:46:54.9Z","temporaryDisk":{"sizeInGB":5,"moun
tPath":"/tmp"},"persistentDisk":{"sizeInGB":0,"mountPath":"/persistent"}},"type":"Microsoft.AppPlatform/Sp
ring/apps","identity":null,"location":"eastus","id":"/subscriptions/$subscriptionId/r
esourceGroups/test-group/providers/Microsoft.AppPlatform/Spring/test-spring-service/apps/pwsh01","name":"pwsh0
1"}]}Lista appar under vårtjänsten "test-spring-service"
Exempel 4
$subscriptionId = (Get-AzContext).Subscription.ID
Invoke-AzRestMethod -SubscriptionId $subscriptionId -ResourceGroupName "test-group" -ResourceProviderName Microsoft.AppPlatform -ResourceType Spring -Name "test-spring-service","demo" -ApiVersion 2020-07-01 -Method GET
Headers : {[Cache-Control, System.String[]], [Pragma, System.String[]], [Vary, System.String[]], [x-ms-request-id,
System.String[]]…}
Version : 1.1
StatusCode : 200
Method : GET
Content : {"properties":{"public":true,"url":"https://test-spring-service-demo.azuremicroservices.io","provisioningState":"
Succeeded","activeDeploymentName":"default","fqdn":"test-spring-service.azuremicroservices.io","httpsOnly":false,
"createdTime":"2022-06-22T02:57:13.272Z","temporaryDisk":{"sizeInGB":5,"mountPath":"/tmp"},"persistentDisk
":{"sizeInGB":0,"mountPath":"/persistent"}},"type":"Microsoft.AppPlatform/Spring/apps","identity":null,"lo
cation":"eastus","id":"/subscriptions/$subscriptionId/resourceGroups/test-group/pr
oviders/Microsoft.AppPlatform/Spring/test-spring-service/apps/demo","name":"demo"}Hämta app "demo" under Spring Cloud Service "test-spring-service"
Exempel 5
# Replace *** with real values
$payload = @{principalId="***"; resourceId="***"; appRoleId="***"} | ConvertTo-Json -Depth 3
Invoke-AzRestMethod -Method POST -Uri https://graph.microsoft.com/v1.0/servicePrincipals/***/appRoleAssignedTo -Payload $payloadAnropa Microsoft Graph API för att tilldela approll genom att konstruera en hashtable, konvertera till en JSON-sträng och skicka nyttolasten till Invoke-AzRestMethod.
Parametrar
-ApiVersion
API-version
| Typ: | String |
| Position: | Named |
| standardvärde: | None |
| Obligatorisk: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-AsJob
Kör cmdlet i bakgrunden
| Typ: | SwitchParameter |
| Position: | Named |
| standardvärde: | None |
| Obligatorisk: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Confirm
Uppmanar dig att bekräfta innan du kör cmdleten.
| Typ: | SwitchParameter |
| Aliases: | cf |
| Position: | Named |
| standardvärde: | None |
| Obligatorisk: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-DefaultProfile
Autentiseringsuppgifter, konto, klientorganisation och prenumeration som används för kommunikation med Azure.
| Typ: | IAzureContextContainer |
| Aliases: | AzContext, AzureRmContext, AzureCredential |
| Position: | Named |
| standardvärde: | None |
| Obligatorisk: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Method
Http-metod
| Typ: | String |
| accepterade värden: | GET, POST, PUT, PATCH, DELETE |
| Position: | Named |
| standardvärde: | None |
| Obligatorisk: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Name
lista över målresursnamn
| Typ: | String[] |
| Position: | Named |
| standardvärde: | None |
| Obligatorisk: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Path
Sökväg till målresursens URL. Värdnamnet för Resource Manager ska inte läggas till.
| Typ: | String |
| Position: | Named |
| standardvärde: | None |
| Obligatorisk: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Payload
Nyttolast för JSON-format
| Typ: | String |
| Position: | Named |
| standardvärde: | None |
| Obligatorisk: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ResourceGroupName
Namn på målresursgrupp
| Typ: | String |
| Position: | Named |
| standardvärde: | None |
| Obligatorisk: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ResourceId
Identifierar-URI som anges av rest-API:et som du anropar. Det bör inte vara resurs-ID för Azure Resource Manager.
| Typ: | Uri |
| Position: | Named |
| standardvärde: | None |
| Obligatorisk: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ResourceProviderName
Namn på målresursprovider
| Typ: | String |
| Position: | Named |
| standardvärde: | None |
| Obligatorisk: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ResourceType
Lista över målresurstyp
| Typ: | String[] |
| Position: | Named |
| standardvärde: | None |
| Obligatorisk: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-SubscriptionId
Målprenumerations-ID
| Typ: | String |
| Position: | Named |
| standardvärde: | None |
| Obligatorisk: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Uri
Enhetlig resursidentifierare för Azure-resurserna. Målresursen måste ha stöd för Azure AD-autentisering och åtkomsttoken härleds enligt resurs-ID. Om resurs-ID inte har angetts härleds värdet enligt inbyggda tjänstsuffix i den aktuella Azure-miljön.
| Typ: | Uri |
| Position: | 1 |
| standardvärde: | None |
| Obligatorisk: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-WhatIf
Visar vad som skulle hända om cmdleten kördes. Cmdleten körs inte.
| Typ: | SwitchParameter |
| Aliases: | wi |
| Position: | Named |
| standardvärde: | None |
| Obligatorisk: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
Indata
System.string
Utdata
Samarbeta med oss på GitHub
Källan för det här innehållet finns på GitHub, där du även kan skapa och granska ärenden och pull-begäranden. Se vår deltagarguide för mer information.
Azure PowerShell
Feedback
Kommer snart: Under hela 2024 kommer vi att fasa ut GitHub-problem som feedbackmekanism för innehåll och ersätta det med ett nytt feedbacksystem. Mer information finns i: https://aka.ms/ContentUserFeedback.
Skicka och visa feedback för