Routes - Update

Aktualizuje istniejącą trasę o określonej nazwie trasy w ramach określonej subskrypcji, grupy zasobów, profilu i punktu końcowego AzureFrontDoor.

PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/afdEndpoints/{endpointName}/routes/{routeName}?api-version=2020-09-01

Parametry identyfikatora URI

Name In Required Type Description
endpointName
path True
  • string

Nazwa punktu końcowego w profilu, który jest unikatowy globalnie.

profileName
path True
  • string

Nazwa profilu sieci CDN, która jest unikatowa w ramach grupy zasobów.

resourceGroupName
path True
  • string

Nazwa grupy zasobów w ramach subskrypcji platformy Azure.

Regex pattern: ^[-\w\._\(\)]+$

routeName
path True
  • string

Nazwa reguły routingu.

subscriptionId
path True
  • string

Identyfikator subskrypcji platformy Azure.

api-version
query True
  • string

Wersja interfejsu API, która ma być używana z żądaniem klienta. Bieżąca wersja to 2020-09-01.

Treść żądania

Name Type Description
properties.compressionSettings

Ustawienia kompresji.

properties.customDomains

Domeny, do których odwołuje się ten punkt końcowy.

properties.enabledState

Określa, czy należy włączyć tę regułę. Dozwolone wartości to "Enabled" lub "Disabled".

properties.forwardingProtocol

Protokół, który będzie używany przez tę regułę podczas przekazywania ruchu do frontonu.

properties.httpsRedirect

Określa, czy ruch HTTP ma być automatycznie przekierowywany do ruchu HTTPS. Należy pamiętać, że jest to prosty sposób skonfigurowania tej reguły, która będzie pierwszą uruchomioną regułą.

properties.linkToDefaultDomain

Czy ta trasa będzie połączona z domyślną domeną punktu końcowego.

properties.originGroup

Odwołanie do grupy pierwotnej.

properties.originPath
  • string

Ścieżka katalogu w pochodzeniu, która AzureFrontDoor może być używana do pobierania zawartości, na przykład contoso.cloudapp.net/originpath.

properties.patternsToMatch
  • string[]

Wzorce trasy dla reguły.

properties.queryStringCachingBehavior

Określa sposób, w jaki usługa CDN buforuje żądania zawierające ciągi zapytań. Można zignorować wszystkie ciągi zapytań podczas buforowania, pomijając buforowanie, aby uniemożliwić żądania, które zawierają ciągi zapytań, lub Buforuj każde żądanie z unikatowym adresem URL.

properties.ruleSets

Zestawy reguł, do których odwołuje się ten punkt końcowy.

properties.supportedProtocols
  • string[]

Lista obsługiwanych protokołów dla tej trasy.

Odpowiedzi

Name Type Description
200 OK

OK

202 Accepted

Zaakceptowano

Other Status Codes

Odpowiedź na błąd sieci CDN opisująca przyczynę niepowodzenia operacji

Zabezpieczenia

azure_auth

Azure Active Directory przepływ OAuth2.

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

Scopes

Name Description
user_impersonation Personifikuj konto użytkownika

Przykłady

Routes_Update

Sample Request

PATCH https://management.azure.com/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/afdEndpoints/endpoint1/routes/route1?api-version=2020-09-01
{
  "properties": {
    "customDomains": [
      {
        "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/customDomains/domain1"
      }
    ],
    "originGroup": {
      "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/originGroups/originGroup1"
    },
    "originPath": null,
    "ruleSets": [
      {
        "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/ruleSets/ruleSet1"
      }
    ],
    "supportedProtocols": [
      "Https",
      "Http"
    ],
    "patternsToMatch": [
      "/*"
    ],
    "compressionSettings": {
      "contentTypesToCompress": [
        "text/html",
        "application/octet-stream"
      ],
      "isCompressionEnabled": true
    },
    "queryStringCachingBehavior": "IgnoreQueryString",
    "forwardingProtocol": "MatchRequest",
    "linkToDefaultDomain": "Enabled",
    "httpsRedirect": "Enabled",
    "enabledState": "Enabled"
  }
}

Sample Response

{
  "name": "route1",
  "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/afdendpoints/endpoint1/routes/route1",
  "type": "Microsoft.Cdn/profiles/afdendpoints/routes",
  "properties": {
    "customDomains": [
      {
        "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/customDomains/domain1"
      }
    ],
    "originGroup": {
      "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/originGroups/originGroup1"
    },
    "originPath": null,
    "ruleSets": [
      {
        "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/ruleSets/ruleSet1"
      }
    ],
    "supportedProtocols": [
      "Https",
      "Http"
    ],
    "patternsToMatch": [
      "/*"
    ],
    "compressionSettings": {
      "contentTypesToCompress": [
        "text/html",
        "application/octet-stream"
      ],
      "isCompressionEnabled": true
    },
    "queryStringCachingBehavior": "IgnoreQueryString",
    "forwardingProtocol": "MatchRequest",
    "linkToDefaultDomain": "Enabled",
    "httpsRedirect": "Enabled",
    "enabledState": "Enabled",
    "provisioningState": "Succeeded",
    "deploymentStatus": "InProgress"
  }
}
{
  "name": "route1",
  "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/afdendpoints/endpoint1/routes/route1",
  "type": "Microsoft.Cdn/profiles/afdendpoints/routes",
  "properties": {
    "customDomains": [
      {
        "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/customDomains/domain1"
      }
    ],
    "originGroup": {
      "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/originGroups/originGroup1"
    },
    "originPath": null,
    "ruleSets": [
      {
        "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/ruleSets/ruleSet1"
      }
    ],
    "supportedProtocols": [
      "Https",
      "Http"
    ],
    "patternsToMatch": [
      "/*"
    ],
    "compressionSettings": {
      "contentTypesToCompress": [
        "text/html",
        "application/octet-stream"
      ],
      "isCompressionEnabled": true
    },
    "queryStringCachingBehavior": "IgnoreQueryString",
    "forwardingProtocol": "MatchRequest",
    "linkToDefaultDomain": "Enabled",
    "httpsRedirect": "Enabled",
    "enabledState": "Enabled",
    "provisioningState": "Updating",
    "deploymentStatus": "NotStarted"
  }
}

Definicje

AfdErrorResponse

Odpowiedź na błąd

AfdProvisioningState

Stan aprowizacji

afdQueryStringCachingBehavior

Określa sposób, w jaki usługa CDN buforuje żądania zawierające ciągi zapytań. Można zignorować wszystkie ciągi zapytań podczas buforowania, pomijając buforowanie, aby uniemożliwić żądania, które zawierają ciągi zapytań, lub Buforuj każde żądanie z unikatowym adresem URL.

CompressionSettings

Ustawienia kompresji.

DeploymentStatus
EnabledState

Określa, czy należy włączyć tę regułę. Dozwolone wartości to "Enabled" lub "Disabled".

ErrorResponse

Odpowiedź na błąd oznacza, że Usługa CDN nie może przetworzyć żądania przychodzącego. Powód jest podany w komunikacie o błędzie.

ForwardingProtocol

Protokół, który będzie używany przez tę regułę podczas przekazywania ruchu do frontonu.

httpsRedirect

Określa, czy ruch HTTP ma być automatycznie przekierowywany do ruchu HTTPS. Należy pamiętać, że jest to prosty sposób skonfigurowania tej reguły, która będzie pierwszą uruchomioną regułą.

IdentityType

Typ tożsamości, która tworzy/modyfikuje zasoby

LinkToDefaultDomain

Czy ta trasa będzie połączona z domyślną domeną punktu końcowego.

ResourceReference

Odwołanie do innego zasobu.

Route

Mapowanie nazw przyjaznych tras na wszelkie informacje dotyczące tras lub informacji poufnych.

RouteUpdateParameters

Obiekt JSON domeny wymagany do tworzenia lub aktualizowania domeny.

SystemData

Tylko do odczytu dane systemowe

AfdErrorResponse

Odpowiedź na błąd

Name Type Description
error

Obiekt błędu.

AfdProvisioningState

Stan aprowizacji

Name Type Description
Creating
  • string
Deleting
  • string
Failed
  • string
Succeeded
  • string
Updating
  • string

afdQueryStringCachingBehavior

Określa sposób, w jaki usługa CDN buforuje żądania zawierające ciągi zapytań. Można zignorować wszystkie ciągi zapytań podczas buforowania, pomijając buforowanie, aby uniemożliwić żądania, które zawierają ciągi zapytań, lub Buforuj każde żądanie z unikatowym adresem URL.

Name Type Description
IgnoreQueryString
  • string
NotSet
  • string
UseQueryString
  • string

CompressionSettings

Ustawienia kompresji.

Name Type Description
contentTypesToCompress
  • string[]

Lista typów zawartości, na których ma zastosowanie kompresja. Wartość powinna być prawidłowym typem MIME.

isCompressionEnabled
  • boolean

Wskazuje, czy kompresja zawartości jest włączona w AzureFrontDoor. Wartość domyślna to false. Jeśli kompresja jest włączona, zawartość będzie obsługiwana jako skompresowana, jeśli użytkownicy zażądają skompresowanej wersji. Zawartość nie zostanie skompresowana w AzureFrontDoor, gdy żądana zawartość jest mniejsza niż 1 bajt lub większa niż 1 MB.

DeploymentStatus

Name Type Description
Failed
  • string
InProgress
  • string
NotStarted
  • string
Succeeded
  • string

EnabledState

Określa, czy należy włączyć tę regułę. Dozwolone wartości to "Enabled" lub "Disabled".

Name Type Description
Disabled
  • string
Enabled
  • string

ErrorResponse

Odpowiedź na błąd oznacza, że Usługa CDN nie może przetworzyć żądania przychodzącego. Powód jest podany w komunikacie o błędzie.

Name Type Description
code
  • string

Kod błędu.

message
  • string

Komunikat o błędzie informujący o tym, dlaczego operacja nie powiodła się.

ForwardingProtocol

Protokół, który będzie używany przez tę regułę podczas przekazywania ruchu do frontonu.

Name Type Description
HttpOnly
  • string
HttpsOnly
  • string
MatchRequest
  • string

httpsRedirect

Określa, czy ruch HTTP ma być automatycznie przekierowywany do ruchu HTTPS. Należy pamiętać, że jest to prosty sposób skonfigurowania tej reguły, która będzie pierwszą uruchomioną regułą.

Name Type Description
Disabled
  • string
Enabled
  • string

IdentityType

Typ tożsamości, która tworzy/modyfikuje zasoby

Name Type Description
application
  • string
key
  • string
managedIdentity
  • string
user
  • string

LinkToDefaultDomain

Czy ta trasa będzie połączona z domyślną domeną punktu końcowego.

Name Type Description
Disabled
  • string
Enabled
  • string

ResourceReference

Odwołanie do innego zasobu.

Name Type Description
id
  • string

Identyfikator zasobu.

Route

Mapowanie nazw przyjaznych tras na wszelkie informacje dotyczące tras lub informacji poufnych.

Name Type Description
id
  • string

Identyfikator zasobu.

name
  • string

Nazwa zasobu.

properties.compressionSettings

Ustawienia kompresji.

properties.customDomains

Domeny, do których odwołuje się ten punkt końcowy.

properties.deploymentStatus
properties.enabledState

Określa, czy należy włączyć tę regułę. Dozwolone wartości to "Enabled" lub "Disabled".

properties.forwardingProtocol

Protokół, który będzie używany przez tę regułę podczas przekazywania ruchu do frontonu.

properties.httpsRedirect

Określa, czy ruch HTTP ma być automatycznie przekierowywany do ruchu HTTPS. Należy pamiętać, że jest to prosty sposób skonfigurowania tej reguły, która będzie pierwszą uruchomioną regułą.

properties.linkToDefaultDomain

Czy ta trasa będzie połączona z domyślną domeną punktu końcowego.

properties.originGroup

Odwołanie do grupy pierwotnej.

properties.originPath
  • string

Ścieżka katalogu w pochodzeniu, która AzureFrontDoor może być używana do pobierania zawartości, na przykład contoso.cloudapp.net/originpath.

properties.patternsToMatch
  • string[]

Wzorce trasy dla reguły.

properties.provisioningState

Stan aprowizacji

properties.queryStringCachingBehavior

Określa sposób, w jaki usługa CDN buforuje żądania zawierające ciągi zapytań. Można zignorować wszystkie ciągi zapytań podczas buforowania, pomijając buforowanie, aby uniemożliwić żądania, które zawierają ciągi zapytań, lub Buforuj każde żądanie z unikatowym adresem URL.

properties.ruleSets

Zestawy reguł, do których odwołuje się ten punkt końcowy.

properties.supportedProtocols
  • string[]

Lista obsługiwanych protokołów dla tej trasy.

systemData

Tylko do odczytu dane systemowe

type
  • string

Typ zasobu.

RouteUpdateParameters

Obiekt JSON domeny wymagany do tworzenia lub aktualizowania domeny.

Name Type Description
properties.compressionSettings

Ustawienia kompresji.

properties.customDomains

Domeny, do których odwołuje się ten punkt końcowy.

properties.enabledState

Określa, czy należy włączyć tę regułę. Dozwolone wartości to "Enabled" lub "Disabled".

properties.forwardingProtocol

Protokół, który będzie używany przez tę regułę podczas przekazywania ruchu do frontonu.

properties.httpsRedirect

Określa, czy ruch HTTP ma być automatycznie przekierowywany do ruchu HTTPS. Należy pamiętać, że jest to prosty sposób skonfigurowania tej reguły, która będzie pierwszą uruchomioną regułą.

properties.linkToDefaultDomain

Czy ta trasa będzie połączona z domyślną domeną punktu końcowego.

properties.originGroup

Odwołanie do grupy pierwotnej.

properties.originPath
  • string

Ścieżka katalogu w pochodzeniu, która AzureFrontDoor może być używana do pobierania zawartości, na przykład contoso.cloudapp.net/originpath.

properties.patternsToMatch
  • string[]

Wzorce trasy dla reguły.

properties.queryStringCachingBehavior

Określa sposób, w jaki usługa CDN buforuje żądania zawierające ciągi zapytań. Można zignorować wszystkie ciągi zapytań podczas buforowania, pomijając buforowanie, aby uniemożliwić żądania, które zawierają ciągi zapytań, lub Buforuj każde żądanie z unikatowym adresem URL.

properties.ruleSets

Zestawy reguł, do których odwołuje się ten punkt końcowy.

properties.supportedProtocols
  • string[]

Lista obsługiwanych protokołów dla tej trasy.

SystemData

Tylko do odczytu dane systemowe

Name Type Description
createdAt
  • string

Sygnatura czasowa tworzenia zasobów (UTC)

createdBy
  • string

Identyfikator tożsamości, która utworzyła zasób

createdByType

Typ tożsamości, która utworzyła zasób

lastModifiedAt
  • string

Sygnatura czasowa ostatniej modyfikacji zasobu (UTC)

lastModifiedBy
  • string

Identyfikator tożsamości, który ostatnio zmodyfikował zasób

lastModifiedByType

Typ tożsamości, który ostatnio zmodyfikował zasób